Skip to content

Commit 9da7c44

Browse files
elasticmachineelasticmachine
authored
Auto-generated code for main (#1984)
1 parent 56b4a38 commit 9da7c44

File tree

4 files changed

+73
-73
lines changed

4 files changed

+73
-73
lines changed

‎docs/reference.asciidoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3335,9 +3335,9 @@ If no response is received before the timeout expires, the request fails and ret
33353335

33363336
[discrete]
33373337
==== delete_data_lifecycle
3338-
Deletes the data lifecycle of the selected data streams.
3338+
Deletes the data stream lifecycle of the selected data streams.
33393339

3340-
{ref}/dlm-delete-lifecycle.html[Endpoint documentation]
3340+
{ref}/data-streams-delete-lifecycle.html[Endpoint documentation]
33413341
[source,ts]
33423342
----
33433343
client.indices.deleteDataLifecycle({ name })
@@ -3347,7 +3347,7 @@ client.indices.deleteDataLifecycle({ name })
33473347
==== Arguments
33483348

33493349
* *Request (object):*
3350-
** *`name` (string | string[])*: A list of data streams of which the data lifecycle will be deleted; use `*` to get all data streams
3350+
** *`name` (string | string[])*: A list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams
33513351
** *`expand_wildcards` (Optional, Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[])*: Whether wildcard expressions should get expanded to open or closed indices (default: open)
33523352
** *`master_timeout` (Optional, string | -1 | 0)*: Specify timeout for connection to master
33533353
** *`timeout` (Optional, string | -1 | 0)*: Explicit timestamp for the document
@@ -3544,9 +3544,9 @@ client.indices.existsTemplate({ name })
35443544

35453545
[discrete]
35463546
==== explain_data_lifecycle
3547-
Retrieves information about the index's current DLM lifecycle, such as any potential encountered error, time since creation etc.
3547+
Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc.
35483548

3549-
{ref}/dlm-explain-lifecycle.html[Endpoint documentation]
3549+
{ref}/data-streams-explain-lifecycle.html[Endpoint documentation]
35503550
[source,ts]
35513551
----
35523552
client.indices.explainDataLifecycle({ index })
@@ -3701,9 +3701,9 @@ Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
37013701

37023702
[discrete]
37033703
==== get_data_lifecycle
3704-
Returns the data lifecycle of the selected data streams.
3704+
Returns the data stream lifecycle of the selected data streams.
37053705

3706-
{ref}/dlm-get-lifecycle.html[Endpoint documentation]
3706+
{ref}/data-streams-get-lifecycle.html[Endpoint documentation]
37073707
[source,ts]
37083708
----
37093709
client.indices.getDataLifecycle({ name })
@@ -3995,9 +3995,9 @@ If no response is received before the timeout expires, the request fails and ret
39953995

39963996
[discrete]
39973997
==== put_data_lifecycle
3998-
Updates the data lifecycle of the selected data streams.
3998+
Updates the data stream lifecycle of the selected data streams.
39993999

4000-
{ref}/dlm-put-lifecycle.html[Endpoint documentation]
4000+
{ref}/data-streams-put-lifecycle.html[Endpoint documentation]
40014001
[source,ts]
40024002
----
40034003
client.indices.putDataLifecycle({ name })

‎src/api/api/indices.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -371,8 +371,8 @@ export default class Indices {
371371
}
372372

373373
/**
374-
* Deletes the data lifecycle of the selected data streams.
375-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/dlm-delete-lifecycle.html | Elasticsearch API documentation}
374+
* Deletes the data stream lifecycle of the selected data streams.
375+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-delete-lifecycle.html | Elasticsearch API documentation}
376376
*/
377377
async deleteDataLifecycle (this: That, params: T.IndicesDeleteDataLifecycleRequest | TB.IndicesDeleteDataLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesDeleteDataLifecycleResponse>
378378
async deleteDataLifecycle (this: That, params: T.IndicesDeleteDataLifecycleRequest | TB.IndicesDeleteDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesDeleteDataLifecycleResponse, unknown>>
@@ -643,8 +643,8 @@ export default class Indices {
643643
}
644644

645645
/**
646-
* Retrieves information about the index's current DLM lifecycle, such as any potential encountered error, time since creation etc.
647-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/dlm-explain-lifecycle.html | Elasticsearch API documentation}
646+
* Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc.
647+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-explain-lifecycle.html | Elasticsearch API documentation}
648648
*/
649649
async explainDataLifecycle (this: That, params: T.IndicesExplainDataLifecycleRequest | TB.IndicesExplainDataLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesExplainDataLifecycleResponse>
650650
async explainDataLifecycle (this: That, params: T.IndicesExplainDataLifecycleRequest | TB.IndicesExplainDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesExplainDataLifecycleResponse, unknown>>
@@ -829,8 +829,8 @@ export default class Indices {
829829
}
830830

831831
/**
832-
* Returns the data lifecycle of the selected data streams.
833-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/dlm-get-lifecycle.html | Elasticsearch API documentation}
832+
* Returns the data stream lifecycle of the selected data streams.
833+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle.html | Elasticsearch API documentation}
834834
*/
835835
async getDataLifecycle (this: That, params: T.IndicesGetDataLifecycleRequest | TB.IndicesGetDataLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesGetDataLifecycleResponse>
836836
async getDataLifecycle (this: That, params: T.IndicesGetDataLifecycleRequest | TB.IndicesGetDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesGetDataLifecycleResponse, unknown>>
@@ -1225,8 +1225,8 @@ export default class Indices {
12251225
}
12261226

12271227
/**
1228-
* Updates the data lifecycle of the selected data streams.
1229-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/dlm-put-lifecycle.html | Elasticsearch API documentation}
1228+
* Updates the data stream lifecycle of the selected data streams.
1229+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-put-lifecycle.html | Elasticsearch API documentation}
12301230
*/
12311231
async putDataLifecycle (this: That, params: T.IndicesPutDataLifecycleRequest | TB.IndicesPutDataLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesPutDataLifecycleResponse>
12321232
async putDataLifecycle (this: That, params: T.IndicesPutDataLifecycleRequest | TB.IndicesPutDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesPutDataLifecycleResponse, unknown>>

‎src/api/types.ts

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -8232,7 +8232,7 @@ export interface ClusterComponentTemplateSummary {
82328232
settings?: Record<IndexName, IndicesIndexSettings>
82338233
mappings?: MappingTypeMapping
82348234
aliases?: Record<string, IndicesAliasDefinition>
8235-
lifecycle?: IndicesDataLifecycleWithRollover
8235+
lifecycle?: IndicesDataStreamLifecycleWithRollover
82368236
}
82378237

82388238
export interface ClusterAllocationExplainAllocationDecision {
@@ -9496,23 +9496,14 @@ export interface IndicesCacheQueries {
94969496
enabled: boolean
94979497
}
94989498

9499-
export interface IndicesDataLifecycle {
9500-
data_retention?: Duration
9501-
}
9502-
9503-
export interface IndicesDataLifecycleWithRollover {
9504-
data_retention?: Duration
9505-
rollover?: IndicesDlmRolloverConditions
9506-
}
9507-
95089499
export interface IndicesDataStream {
95099500
_meta?: Metadata
95109501
allow_custom_routing?: boolean
95119502
generation: integer
95129503
hidden: boolean
95139504
ilm_policy?: Name
95149505
indices: IndicesDataStreamIndex[]
9515-
lifecycle?: IndicesDataLifecycleWithRollover
9506+
lifecycle?: IndicesDataStreamLifecycleWithRollover
95169507
name: DataStreamName
95179508
replicated?: boolean
95189509
status: HealthStatus
@@ -9526,15 +9517,11 @@ export interface IndicesDataStreamIndex {
95269517
index_uuid: Uuid
95279518
}
95289519

9529-
export interface IndicesDataStreamTimestampField {
9530-
name: Field
9531-
}
9532-
9533-
export interface IndicesDataStreamVisibility {
9534-
hidden?: boolean
9520+
export interface IndicesDataStreamLifecycle {
9521+
data_retention?: Duration
95359522
}
95369523

9537-
export interface IndicesDlmRolloverConditions {
9524+
export interface IndicesDataStreamLifecycleRolloverConditions {
95389525
min_age?: Duration
95399526
max_age?: string
95409527
min_docs?: long
@@ -9547,6 +9534,19 @@ export interface IndicesDlmRolloverConditions {
95479534
max_primary_shard_docs?: long
95489535
}
95499536

9537+
export interface IndicesDataStreamLifecycleWithRollover {
9538+
data_retention?: Duration
9539+
rollover?: IndicesDataStreamLifecycleRolloverConditions
9540+
}
9541+
9542+
export interface IndicesDataStreamTimestampField {
9543+
name: Field
9544+
}
9545+
9546+
export interface IndicesDataStreamVisibility {
9547+
hidden?: boolean
9548+
}
9549+
95509550
export interface IndicesDownsampleConfig {
95519551
fixed_interval: DurationLarge
95529552
}
@@ -9701,7 +9701,7 @@ export interface IndicesIndexState {
97019701
settings?: IndicesIndexSettings
97029702
defaults?: IndicesIndexSettings
97039703
data_stream?: DataStreamName
9704-
lifecycle?: IndicesDataLifecycle
9704+
lifecycle?: IndicesDataStreamLifecycle
97059705
}
97069706

97079707
export interface IndicesIndexTemplate {
@@ -9724,7 +9724,7 @@ export interface IndicesIndexTemplateSummary {
97249724
aliases?: Record<IndexName, IndicesAlias>
97259725
mappings?: MappingTypeMapping
97269726
settings?: IndicesIndexSettings
9727-
lifecycle?: IndicesDataLifecycleWithRollover
9727+
lifecycle?: IndicesDataStreamLifecycleWithRollover
97289728
}
97299729

97309730
export interface IndicesIndexVersioning {
@@ -10238,14 +10238,14 @@ export interface IndicesExistsTemplateRequest extends RequestBase {
1023810238

1023910239
export type IndicesExistsTemplateResponse = boolean
1024010240

10241-
export interface IndicesExplainDataLifecycleDataLifecycleExplain {
10241+
export interface IndicesExplainDataLifecycleDataStreamLifecycleExplain {
1024210242
index: IndexName
10243-
managed_by_dlm: boolean
10243+
managed_by_lifecycle: boolean
1024410244
index_creation_date_millis?: EpochTime<UnitMillis>
1024510245
time_since_index_creation?: Duration
1024610246
rollover_date_millis?: EpochTime<UnitMillis>
1024710247
time_since_rollover?: Duration
10248-
lifecycle?: IndicesDataLifecycleWithRollover
10248+
lifecycle?: IndicesDataStreamLifecycleWithRollover
1024910249
generation_time?: Duration
1025010250
error?: string
1025110251
}
@@ -10257,7 +10257,7 @@ export interface IndicesExplainDataLifecycleRequest extends RequestBase {
1025710257
}
1025810258

1025910259
export interface IndicesExplainDataLifecycleResponse {
10260-
indices: Record<IndexName, IndicesExplainDataLifecycleDataLifecycleExplain>
10260+
indices: Record<IndexName, IndicesExplainDataLifecycleDataStreamLifecycleExplain>
1026110261
}
1026210262

1026310263
export interface IndicesFieldUsageStatsFieldSummary {
@@ -10377,9 +10377,9 @@ export interface IndicesGetAliasRequest extends RequestBase {
1037710377

1037810378
export type IndicesGetAliasResponse = Record<IndexName, IndicesGetAliasIndexAliases>
1037910379

10380-
export interface IndicesGetDataLifecycleDataStreamLifecycle {
10380+
export interface IndicesGetDataLifecycleDataStreamWithLifecycle {
1038110381
name: DataStreamName
10382-
lifecycle?: IndicesDataLifecycle
10382+
lifecycle?: IndicesDataStreamLifecycle
1038310383
}
1038410384

1038510385
export interface IndicesGetDataLifecycleRequest extends RequestBase {
@@ -10389,7 +10389,7 @@ export interface IndicesGetDataLifecycleRequest extends RequestBase {
1038910389
}
1039010390

1039110391
export interface IndicesGetDataLifecycleResponse {
10392-
data_streams: IndicesGetDataLifecycleDataStreamLifecycle[]
10392+
data_streams: IndicesGetDataLifecycleDataStreamWithLifecycle[]
1039310393
}
1039410394

1039510395
export interface IndicesGetDataStreamRequest extends RequestBase {
@@ -10545,7 +10545,7 @@ export interface IndicesPutIndexTemplateIndexTemplateMapping {
1054510545
aliases?: Record<IndexName, IndicesAlias>
1054610546
mappings?: MappingTypeMapping
1054710547
settings?: IndicesIndexSettings
10548-
lifecycle?: IndicesDataLifecycle
10548+
lifecycle?: IndicesDataStreamLifecycle
1054910549
}
1055010550

1055110551
export interface IndicesPutIndexTemplateRequest extends RequestBase {

‎src/api/typesWithBodyKey.ts

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -8321,7 +8321,7 @@ export interface ClusterComponentTemplateSummary {
83218321
settings?: Record<IndexName, IndicesIndexSettings>
83228322
mappings?: MappingTypeMapping
83238323
aliases?: Record<string, IndicesAliasDefinition>
8324-
lifecycle?: IndicesDataLifecycleWithRollover
8324+
lifecycle?: IndicesDataStreamLifecycleWithRollover
83258325
}
83268326

83278327
export interface ClusterAllocationExplainAllocationDecision {
@@ -9619,23 +9619,14 @@ export interface IndicesCacheQueries {
96199619
enabled: boolean
96209620
}
96219621

9622-
export interface IndicesDataLifecycle {
9623-
data_retention?: Duration
9624-
}
9625-
9626-
export interface IndicesDataLifecycleWithRollover {
9627-
data_retention?: Duration
9628-
rollover?: IndicesDlmRolloverConditions
9629-
}
9630-
96319622
export interface IndicesDataStream {
96329623
_meta?: Metadata
96339624
allow_custom_routing?: boolean
96349625
generation: integer
96359626
hidden: boolean
96369627
ilm_policy?: Name
96379628
indices: IndicesDataStreamIndex[]
9638-
lifecycle?: IndicesDataLifecycleWithRollover
9629+
lifecycle?: IndicesDataStreamLifecycleWithRollover
96399630
name: DataStreamName
96409631
replicated?: boolean
96419632
status: HealthStatus
@@ -9649,15 +9640,11 @@ export interface IndicesDataStreamIndex {
96499640
index_uuid: Uuid
96509641
}
96519642

9652-
export interface IndicesDataStreamTimestampField {
9653-
name: Field
9654-
}
9655-
9656-
export interface IndicesDataStreamVisibility {
9657-
hidden?: boolean
9643+
export interface IndicesDataStreamLifecycle {
9644+
data_retention?: Duration
96589645
}
96599646

9660-
export interface IndicesDlmRolloverConditions {
9647+
export interface IndicesDataStreamLifecycleRolloverConditions {
96619648
min_age?: Duration
96629649
max_age?: string
96639650
min_docs?: long
@@ -9670,6 +9657,19 @@ export interface IndicesDlmRolloverConditions {
96709657
max_primary_shard_docs?: long
96719658
}
96729659

9660+
export interface IndicesDataStreamLifecycleWithRollover {
9661+
data_retention?: Duration
9662+
rollover?: IndicesDataStreamLifecycleRolloverConditions
9663+
}
9664+
9665+
export interface IndicesDataStreamTimestampField {
9666+
name: Field
9667+
}
9668+
9669+
export interface IndicesDataStreamVisibility {
9670+
hidden?: boolean
9671+
}
9672+
96739673
export interface IndicesDownsampleConfig {
96749674
fixed_interval: DurationLarge
96759675
}
@@ -9824,7 +9824,7 @@ export interface IndicesIndexState {
98249824
settings?: IndicesIndexSettings
98259825
defaults?: IndicesIndexSettings
98269826
data_stream?: DataStreamName
9827-
lifecycle?: IndicesDataLifecycle
9827+
lifecycle?: IndicesDataStreamLifecycle
98289828
}
98299829

98309830
export interface IndicesIndexTemplate {
@@ -9847,7 +9847,7 @@ export interface IndicesIndexTemplateSummary {
98479847
aliases?: Record<IndexName, IndicesAlias>
98489848
mappings?: MappingTypeMapping
98499849
settings?: IndicesIndexSettings
9850-
lifecycle?: IndicesDataLifecycleWithRollover
9850+
lifecycle?: IndicesDataStreamLifecycleWithRollover
98519851
}
98529852

98539853
export interface IndicesIndexVersioning {
@@ -10371,14 +10371,14 @@ export interface IndicesExistsTemplateRequest extends RequestBase {
1037110371

1037210372
export type IndicesExistsTemplateResponse = boolean
1037310373

10374-
export interface IndicesExplainDataLifecycleDataLifecycleExplain {
10374+
export interface IndicesExplainDataLifecycleDataStreamLifecycleExplain {
1037510375
index: IndexName
10376-
managed_by_dlm: boolean
10376+
managed_by_lifecycle: boolean
1037710377
index_creation_date_millis?: EpochTime<UnitMillis>
1037810378
time_since_index_creation?: Duration
1037910379
rollover_date_millis?: EpochTime<UnitMillis>
1038010380
time_since_rollover?: Duration
10381-
lifecycle?: IndicesDataLifecycleWithRollover
10381+
lifecycle?: IndicesDataStreamLifecycleWithRollover
1038210382
generation_time?: Duration
1038310383
error?: string
1038410384
}
@@ -10390,7 +10390,7 @@ export interface IndicesExplainDataLifecycleRequest extends RequestBase {
1039010390
}
1039110391

1039210392
export interface IndicesExplainDataLifecycleResponse {
10393-
indices: Record<IndexName, IndicesExplainDataLifecycleDataLifecycleExplain>
10393+
indices: Record<IndexName, IndicesExplainDataLifecycleDataStreamLifecycleExplain>
1039410394
}
1039510395

1039610396
export interface IndicesFieldUsageStatsFieldSummary {
@@ -10510,9 +10510,9 @@ export interface IndicesGetAliasRequest extends RequestBase {
1051010510

1051110511
export type IndicesGetAliasResponse = Record<IndexName, IndicesGetAliasIndexAliases>
1051210512

10513-
export interface IndicesGetDataLifecycleDataStreamLifecycle {
10513+
export interface IndicesGetDataLifecycleDataStreamWithLifecycle {
1051410514
name: DataStreamName
10515-
lifecycle?: IndicesDataLifecycle
10515+
lifecycle?: IndicesDataStreamLifecycle
1051610516
}
1051710517

1051810518
export interface IndicesGetDataLifecycleRequest extends RequestBase {
@@ -10522,7 +10522,7 @@ export interface IndicesGetDataLifecycleRequest extends RequestBase {
1052210522
}
1052310523

1052410524
export interface IndicesGetDataLifecycleResponse {
10525-
data_streams: IndicesGetDataLifecycleDataStreamLifecycle[]
10525+
data_streams: IndicesGetDataLifecycleDataStreamWithLifecycle[]
1052610526
}
1052710527

1052810528
export interface IndicesGetDataStreamRequest extends RequestBase {
@@ -10687,7 +10687,7 @@ export interface IndicesPutIndexTemplateIndexTemplateMapping {
1068710687
aliases?: Record<IndexName, IndicesAlias>
1068810688
mappings?: MappingTypeMapping
1068910689
settings?: IndicesIndexSettings
10690-
lifecycle?: IndicesDataLifecycle
10690+
lifecycle?: IndicesDataStreamLifecycle
1069110691
}
1069210692

1069310693
export interface IndicesPutIndexTemplateRequest extends RequestBase {

0 commit comments

Comments
 (0)