From 9da7c44bb012e1ff7f1d3b656ea83462f477cc51 Mon Sep 17 00:00:00 2001 From: Elastic Machine Date: Fri, 25 Aug 2023 00:23:40 +0930 Subject: [PATCH] Auto-generated code for main (#1984) --- docs/reference.asciidoc | 18 ++++++------ src/api/api/indices.ts | 16 +++++------ src/api/types.ts | 56 ++++++++++++++++++------------------- src/api/typesWithBodyKey.ts | 56 ++++++++++++++++++------------------- 4 files changed, 73 insertions(+), 73 deletions(-) diff --git a/docs/reference.asciidoc b/docs/reference.asciidoc index 5d35bb0bc..85475327b 100644 --- a/docs/reference.asciidoc +++ b/docs/reference.asciidoc @@ -3335,9 +3335,9 @@ If no response is received before the timeout expires, the request fails and ret [discrete] ==== delete_data_lifecycle -Deletes the data lifecycle of the selected data streams. +Deletes the data stream lifecycle of the selected data streams. -{ref}/dlm-delete-lifecycle.html[Endpoint documentation] +{ref}/data-streams-delete-lifecycle.html[Endpoint documentation] [source,ts] ---- client.indices.deleteDataLifecycle({ name }) @@ -3347,7 +3347,7 @@ client.indices.deleteDataLifecycle({ name }) ==== Arguments * *Request (object):* -** *`name` (string | string[])*: A list of data streams of which the data lifecycle will be deleted; use `*` to get all data streams +** *`name` (string | string[])*: A list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams ** *`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) ** *`master_timeout` (Optional, string | -1 | 0)*: Specify timeout for connection to master ** *`timeout` (Optional, string | -1 | 0)*: Explicit timestamp for the document @@ -3544,9 +3544,9 @@ client.indices.existsTemplate({ name }) [discrete] ==== explain_data_lifecycle -Retrieves information about the index's current DLM lifecycle, such as any potential encountered error, time since creation etc. +Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc. -{ref}/dlm-explain-lifecycle.html[Endpoint documentation] +{ref}/data-streams-explain-lifecycle.html[Endpoint documentation] [source,ts] ---- client.indices.explainDataLifecycle({ index }) @@ -3701,9 +3701,9 @@ Valid values are: `all`, `open`, `closed`, `hidden`, `none`. [discrete] ==== get_data_lifecycle -Returns the data lifecycle of the selected data streams. +Returns the data stream lifecycle of the selected data streams. -{ref}/dlm-get-lifecycle.html[Endpoint documentation] +{ref}/data-streams-get-lifecycle.html[Endpoint documentation] [source,ts] ---- client.indices.getDataLifecycle({ name }) @@ -3995,9 +3995,9 @@ If no response is received before the timeout expires, the request fails and ret [discrete] ==== put_data_lifecycle -Updates the data lifecycle of the selected data streams. +Updates the data stream lifecycle of the selected data streams. -{ref}/dlm-put-lifecycle.html[Endpoint documentation] +{ref}/data-streams-put-lifecycle.html[Endpoint documentation] [source,ts] ---- client.indices.putDataLifecycle({ name }) diff --git a/src/api/api/indices.ts b/src/api/api/indices.ts index 4ef0eac17..2dcf18270 100644 --- a/src/api/api/indices.ts +++ b/src/api/api/indices.ts @@ -371,8 +371,8 @@ export default class Indices { } /** - * Deletes the data lifecycle of the selected data streams. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/dlm-delete-lifecycle.html | Elasticsearch API documentation} + * Deletes the data stream lifecycle of the selected data streams. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-delete-lifecycle.html | Elasticsearch API documentation} */ async deleteDataLifecycle (this: That, params: T.IndicesDeleteDataLifecycleRequest | TB.IndicesDeleteDataLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async deleteDataLifecycle (this: That, params: T.IndicesDeleteDataLifecycleRequest | TB.IndicesDeleteDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -643,8 +643,8 @@ export default class Indices { } /** - * Retrieves information about the index's current DLM lifecycle, such as any potential encountered error, time since creation etc. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/dlm-explain-lifecycle.html | Elasticsearch API documentation} + * Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-explain-lifecycle.html | Elasticsearch API documentation} */ async explainDataLifecycle (this: That, params: T.IndicesExplainDataLifecycleRequest | TB.IndicesExplainDataLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async explainDataLifecycle (this: That, params: T.IndicesExplainDataLifecycleRequest | TB.IndicesExplainDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -829,8 +829,8 @@ export default class Indices { } /** - * Returns the data lifecycle of the selected data streams. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/dlm-get-lifecycle.html | Elasticsearch API documentation} + * Returns the data stream lifecycle of the selected data streams. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle.html | Elasticsearch API documentation} */ async getDataLifecycle (this: That, params: T.IndicesGetDataLifecycleRequest | TB.IndicesGetDataLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async getDataLifecycle (this: That, params: T.IndicesGetDataLifecycleRequest | TB.IndicesGetDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> @@ -1225,8 +1225,8 @@ export default class Indices { } /** - * Updates the data lifecycle of the selected data streams. - * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/dlm-put-lifecycle.html | Elasticsearch API documentation} + * Updates the data stream lifecycle of the selected data streams. + * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-put-lifecycle.html | Elasticsearch API documentation} */ async putDataLifecycle (this: That, params: T.IndicesPutDataLifecycleRequest | TB.IndicesPutDataLifecycleRequest, options?: TransportRequestOptionsWithOutMeta): Promise async putDataLifecycle (this: That, params: T.IndicesPutDataLifecycleRequest | TB.IndicesPutDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise> diff --git a/src/api/types.ts b/src/api/types.ts index 93a57fa12..74f1227a2 100644 --- a/src/api/types.ts +++ b/src/api/types.ts @@ -8232,7 +8232,7 @@ export interface ClusterComponentTemplateSummary { settings?: Record mappings?: MappingTypeMapping aliases?: Record - lifecycle?: IndicesDataLifecycleWithRollover + lifecycle?: IndicesDataStreamLifecycleWithRollover } export interface ClusterAllocationExplainAllocationDecision { @@ -9496,15 +9496,6 @@ export interface IndicesCacheQueries { enabled: boolean } -export interface IndicesDataLifecycle { - data_retention?: Duration -} - -export interface IndicesDataLifecycleWithRollover { - data_retention?: Duration - rollover?: IndicesDlmRolloverConditions -} - export interface IndicesDataStream { _meta?: Metadata allow_custom_routing?: boolean @@ -9512,7 +9503,7 @@ export interface IndicesDataStream { hidden: boolean ilm_policy?: Name indices: IndicesDataStreamIndex[] - lifecycle?: IndicesDataLifecycleWithRollover + lifecycle?: IndicesDataStreamLifecycleWithRollover name: DataStreamName replicated?: boolean status: HealthStatus @@ -9526,15 +9517,11 @@ export interface IndicesDataStreamIndex { index_uuid: Uuid } -export interface IndicesDataStreamTimestampField { - name: Field +export interface IndicesDataStreamLifecycle { + data_retention?: Duration } -export interface IndicesDataStreamVisibility { - hidden?: boolean -} - -export interface IndicesDlmRolloverConditions { +export interface IndicesDataStreamLifecycleRolloverConditions { min_age?: Duration max_age?: string min_docs?: long @@ -9547,6 +9534,19 @@ export interface IndicesDlmRolloverConditions { max_primary_shard_docs?: long } +export interface IndicesDataStreamLifecycleWithRollover { + data_retention?: Duration + rollover?: IndicesDataStreamLifecycleRolloverConditions +} + +export interface IndicesDataStreamTimestampField { + name: Field +} + +export interface IndicesDataStreamVisibility { + hidden?: boolean +} + export interface IndicesDownsampleConfig { fixed_interval: DurationLarge } @@ -9701,7 +9701,7 @@ export interface IndicesIndexState { settings?: IndicesIndexSettings defaults?: IndicesIndexSettings data_stream?: DataStreamName - lifecycle?: IndicesDataLifecycle + lifecycle?: IndicesDataStreamLifecycle } export interface IndicesIndexTemplate { @@ -9724,7 +9724,7 @@ export interface IndicesIndexTemplateSummary { aliases?: Record mappings?: MappingTypeMapping settings?: IndicesIndexSettings - lifecycle?: IndicesDataLifecycleWithRollover + lifecycle?: IndicesDataStreamLifecycleWithRollover } export interface IndicesIndexVersioning { @@ -10238,14 +10238,14 @@ export interface IndicesExistsTemplateRequest extends RequestBase { export type IndicesExistsTemplateResponse = boolean -export interface IndicesExplainDataLifecycleDataLifecycleExplain { +export interface IndicesExplainDataLifecycleDataStreamLifecycleExplain { index: IndexName - managed_by_dlm: boolean + managed_by_lifecycle: boolean index_creation_date_millis?: EpochTime time_since_index_creation?: Duration rollover_date_millis?: EpochTime time_since_rollover?: Duration - lifecycle?: IndicesDataLifecycleWithRollover + lifecycle?: IndicesDataStreamLifecycleWithRollover generation_time?: Duration error?: string } @@ -10257,7 +10257,7 @@ export interface IndicesExplainDataLifecycleRequest extends RequestBase { } export interface IndicesExplainDataLifecycleResponse { - indices: Record + indices: Record } export interface IndicesFieldUsageStatsFieldSummary { @@ -10377,9 +10377,9 @@ export interface IndicesGetAliasRequest extends RequestBase { export type IndicesGetAliasResponse = Record -export interface IndicesGetDataLifecycleDataStreamLifecycle { +export interface IndicesGetDataLifecycleDataStreamWithLifecycle { name: DataStreamName - lifecycle?: IndicesDataLifecycle + lifecycle?: IndicesDataStreamLifecycle } export interface IndicesGetDataLifecycleRequest extends RequestBase { @@ -10389,7 +10389,7 @@ export interface IndicesGetDataLifecycleRequest extends RequestBase { } export interface IndicesGetDataLifecycleResponse { - data_streams: IndicesGetDataLifecycleDataStreamLifecycle[] + data_streams: IndicesGetDataLifecycleDataStreamWithLifecycle[] } export interface IndicesGetDataStreamRequest extends RequestBase { @@ -10545,7 +10545,7 @@ export interface IndicesPutIndexTemplateIndexTemplateMapping { aliases?: Record mappings?: MappingTypeMapping settings?: IndicesIndexSettings - lifecycle?: IndicesDataLifecycle + lifecycle?: IndicesDataStreamLifecycle } export interface IndicesPutIndexTemplateRequest extends RequestBase { diff --git a/src/api/typesWithBodyKey.ts b/src/api/typesWithBodyKey.ts index c79b0fbba..a1710a897 100644 --- a/src/api/typesWithBodyKey.ts +++ b/src/api/typesWithBodyKey.ts @@ -8321,7 +8321,7 @@ export interface ClusterComponentTemplateSummary { settings?: Record mappings?: MappingTypeMapping aliases?: Record - lifecycle?: IndicesDataLifecycleWithRollover + lifecycle?: IndicesDataStreamLifecycleWithRollover } export interface ClusterAllocationExplainAllocationDecision { @@ -9619,15 +9619,6 @@ export interface IndicesCacheQueries { enabled: boolean } -export interface IndicesDataLifecycle { - data_retention?: Duration -} - -export interface IndicesDataLifecycleWithRollover { - data_retention?: Duration - rollover?: IndicesDlmRolloverConditions -} - export interface IndicesDataStream { _meta?: Metadata allow_custom_routing?: boolean @@ -9635,7 +9626,7 @@ export interface IndicesDataStream { hidden: boolean ilm_policy?: Name indices: IndicesDataStreamIndex[] - lifecycle?: IndicesDataLifecycleWithRollover + lifecycle?: IndicesDataStreamLifecycleWithRollover name: DataStreamName replicated?: boolean status: HealthStatus @@ -9649,15 +9640,11 @@ export interface IndicesDataStreamIndex { index_uuid: Uuid } -export interface IndicesDataStreamTimestampField { - name: Field +export interface IndicesDataStreamLifecycle { + data_retention?: Duration } -export interface IndicesDataStreamVisibility { - hidden?: boolean -} - -export interface IndicesDlmRolloverConditions { +export interface IndicesDataStreamLifecycleRolloverConditions { min_age?: Duration max_age?: string min_docs?: long @@ -9670,6 +9657,19 @@ export interface IndicesDlmRolloverConditions { max_primary_shard_docs?: long } +export interface IndicesDataStreamLifecycleWithRollover { + data_retention?: Duration + rollover?: IndicesDataStreamLifecycleRolloverConditions +} + +export interface IndicesDataStreamTimestampField { + name: Field +} + +export interface IndicesDataStreamVisibility { + hidden?: boolean +} + export interface IndicesDownsampleConfig { fixed_interval: DurationLarge } @@ -9824,7 +9824,7 @@ export interface IndicesIndexState { settings?: IndicesIndexSettings defaults?: IndicesIndexSettings data_stream?: DataStreamName - lifecycle?: IndicesDataLifecycle + lifecycle?: IndicesDataStreamLifecycle } export interface IndicesIndexTemplate { @@ -9847,7 +9847,7 @@ export interface IndicesIndexTemplateSummary { aliases?: Record mappings?: MappingTypeMapping settings?: IndicesIndexSettings - lifecycle?: IndicesDataLifecycleWithRollover + lifecycle?: IndicesDataStreamLifecycleWithRollover } export interface IndicesIndexVersioning { @@ -10371,14 +10371,14 @@ export interface IndicesExistsTemplateRequest extends RequestBase { export type IndicesExistsTemplateResponse = boolean -export interface IndicesExplainDataLifecycleDataLifecycleExplain { +export interface IndicesExplainDataLifecycleDataStreamLifecycleExplain { index: IndexName - managed_by_dlm: boolean + managed_by_lifecycle: boolean index_creation_date_millis?: EpochTime time_since_index_creation?: Duration rollover_date_millis?: EpochTime time_since_rollover?: Duration - lifecycle?: IndicesDataLifecycleWithRollover + lifecycle?: IndicesDataStreamLifecycleWithRollover generation_time?: Duration error?: string } @@ -10390,7 +10390,7 @@ export interface IndicesExplainDataLifecycleRequest extends RequestBase { } export interface IndicesExplainDataLifecycleResponse { - indices: Record + indices: Record } export interface IndicesFieldUsageStatsFieldSummary { @@ -10510,9 +10510,9 @@ export interface IndicesGetAliasRequest extends RequestBase { export type IndicesGetAliasResponse = Record -export interface IndicesGetDataLifecycleDataStreamLifecycle { +export interface IndicesGetDataLifecycleDataStreamWithLifecycle { name: DataStreamName - lifecycle?: IndicesDataLifecycle + lifecycle?: IndicesDataStreamLifecycle } export interface IndicesGetDataLifecycleRequest extends RequestBase { @@ -10522,7 +10522,7 @@ export interface IndicesGetDataLifecycleRequest extends RequestBase { } export interface IndicesGetDataLifecycleResponse { - data_streams: IndicesGetDataLifecycleDataStreamLifecycle[] + data_streams: IndicesGetDataLifecycleDataStreamWithLifecycle[] } export interface IndicesGetDataStreamRequest extends RequestBase { @@ -10687,7 +10687,7 @@ export interface IndicesPutIndexTemplateIndexTemplateMapping { aliases?: Record mappings?: MappingTypeMapping settings?: IndicesIndexSettings - lifecycle?: IndicesDataLifecycle + lifecycle?: IndicesDataStreamLifecycle } export interface IndicesPutIndexTemplateRequest extends RequestBase {