Skip to content

Auto-generated code for main #1984

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 24, 2023
Merged

Auto-generated code for main #1984

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/reference.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 })
Expand All @@ -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
Expand Down Expand Up @@ -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 })
Expand Down Expand Up @@ -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 })
Expand Down Expand Up @@ -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 })
Expand Down
16 changes: 8 additions & 8 deletions src/api/api/indices.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<T.IndicesDeleteDataLifecycleResponse>
async deleteDataLifecycle (this: That, params: T.IndicesDeleteDataLifecycleRequest | TB.IndicesDeleteDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesDeleteDataLifecycleResponse, unknown>>
Expand Down Expand Up @@ -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<T.IndicesExplainDataLifecycleResponse>
async explainDataLifecycle (this: That, params: T.IndicesExplainDataLifecycleRequest | TB.IndicesExplainDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesExplainDataLifecycleResponse, unknown>>
Expand Down Expand Up @@ -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<T.IndicesGetDataLifecycleResponse>
async getDataLifecycle (this: That, params: T.IndicesGetDataLifecycleRequest | TB.IndicesGetDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesGetDataLifecycleResponse, unknown>>
Expand Down Expand Up @@ -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<T.IndicesPutDataLifecycleResponse>
async putDataLifecycle (this: That, params: T.IndicesPutDataLifecycleRequest | TB.IndicesPutDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesPutDataLifecycleResponse, unknown>>
Expand Down
56 changes: 28 additions & 28 deletions src/api/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8232,7 +8232,7 @@ export interface ClusterComponentTemplateSummary {
settings?: Record<IndexName, IndicesIndexSettings>
mappings?: MappingTypeMapping
aliases?: Record<string, IndicesAliasDefinition>
lifecycle?: IndicesDataLifecycleWithRollover
lifecycle?: IndicesDataStreamLifecycleWithRollover
}

export interface ClusterAllocationExplainAllocationDecision {
Expand Down Expand Up @@ -9496,23 +9496,14 @@ 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
generation: integer
hidden: boolean
ilm_policy?: Name
indices: IndicesDataStreamIndex[]
lifecycle?: IndicesDataLifecycleWithRollover
lifecycle?: IndicesDataStreamLifecycleWithRollover
name: DataStreamName
replicated?: boolean
status: HealthStatus
Expand All @@ -9526,15 +9517,11 @@ export interface IndicesDataStreamIndex {
index_uuid: Uuid
}

export interface IndicesDataStreamTimestampField {
name: Field
}

export interface IndicesDataStreamVisibility {
hidden?: boolean
export interface IndicesDataStreamLifecycle {
data_retention?: Duration
}

export interface IndicesDlmRolloverConditions {
export interface IndicesDataStreamLifecycleRolloverConditions {
min_age?: Duration
max_age?: string
min_docs?: long
Expand All @@ -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
}
Expand Down Expand Up @@ -9701,7 +9701,7 @@ export interface IndicesIndexState {
settings?: IndicesIndexSettings
defaults?: IndicesIndexSettings
data_stream?: DataStreamName
lifecycle?: IndicesDataLifecycle
lifecycle?: IndicesDataStreamLifecycle
}

export interface IndicesIndexTemplate {
Expand All @@ -9724,7 +9724,7 @@ export interface IndicesIndexTemplateSummary {
aliases?: Record<IndexName, IndicesAlias>
mappings?: MappingTypeMapping
settings?: IndicesIndexSettings
lifecycle?: IndicesDataLifecycleWithRollover
lifecycle?: IndicesDataStreamLifecycleWithRollover
}

export interface IndicesIndexVersioning {
Expand Down Expand Up @@ -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<UnitMillis>
time_since_index_creation?: Duration
rollover_date_millis?: EpochTime<UnitMillis>
time_since_rollover?: Duration
lifecycle?: IndicesDataLifecycleWithRollover
lifecycle?: IndicesDataStreamLifecycleWithRollover
generation_time?: Duration
error?: string
}
Expand All @@ -10257,7 +10257,7 @@ export interface IndicesExplainDataLifecycleRequest extends RequestBase {
}

export interface IndicesExplainDataLifecycleResponse {
indices: Record<IndexName, IndicesExplainDataLifecycleDataLifecycleExplain>
indices: Record<IndexName, IndicesExplainDataLifecycleDataStreamLifecycleExplain>
}

export interface IndicesFieldUsageStatsFieldSummary {
Expand Down Expand Up @@ -10377,9 +10377,9 @@ export interface IndicesGetAliasRequest extends RequestBase {

export type IndicesGetAliasResponse = Record<IndexName, IndicesGetAliasIndexAliases>

export interface IndicesGetDataLifecycleDataStreamLifecycle {
export interface IndicesGetDataLifecycleDataStreamWithLifecycle {
name: DataStreamName
lifecycle?: IndicesDataLifecycle
lifecycle?: IndicesDataStreamLifecycle
}

export interface IndicesGetDataLifecycleRequest extends RequestBase {
Expand All @@ -10389,7 +10389,7 @@ export interface IndicesGetDataLifecycleRequest extends RequestBase {
}

export interface IndicesGetDataLifecycleResponse {
data_streams: IndicesGetDataLifecycleDataStreamLifecycle[]
data_streams: IndicesGetDataLifecycleDataStreamWithLifecycle[]
}

export interface IndicesGetDataStreamRequest extends RequestBase {
Expand Down Expand Up @@ -10545,7 +10545,7 @@ export interface IndicesPutIndexTemplateIndexTemplateMapping {
aliases?: Record<IndexName, IndicesAlias>
mappings?: MappingTypeMapping
settings?: IndicesIndexSettings
lifecycle?: IndicesDataLifecycle
lifecycle?: IndicesDataStreamLifecycle
}

export interface IndicesPutIndexTemplateRequest extends RequestBase {
Expand Down
56 changes: 28 additions & 28 deletions src/api/typesWithBodyKey.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8321,7 +8321,7 @@ export interface ClusterComponentTemplateSummary {
settings?: Record<IndexName, IndicesIndexSettings>
mappings?: MappingTypeMapping
aliases?: Record<string, IndicesAliasDefinition>
lifecycle?: IndicesDataLifecycleWithRollover
lifecycle?: IndicesDataStreamLifecycleWithRollover
}

export interface ClusterAllocationExplainAllocationDecision {
Expand Down Expand Up @@ -9619,23 +9619,14 @@ 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
generation: integer
hidden: boolean
ilm_policy?: Name
indices: IndicesDataStreamIndex[]
lifecycle?: IndicesDataLifecycleWithRollover
lifecycle?: IndicesDataStreamLifecycleWithRollover
name: DataStreamName
replicated?: boolean
status: HealthStatus
Expand All @@ -9649,15 +9640,11 @@ export interface IndicesDataStreamIndex {
index_uuid: Uuid
}

export interface IndicesDataStreamTimestampField {
name: Field
}

export interface IndicesDataStreamVisibility {
hidden?: boolean
export interface IndicesDataStreamLifecycle {
data_retention?: Duration
}

export interface IndicesDlmRolloverConditions {
export interface IndicesDataStreamLifecycleRolloverConditions {
min_age?: Duration
max_age?: string
min_docs?: long
Expand All @@ -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
}
Expand Down Expand Up @@ -9824,7 +9824,7 @@ export interface IndicesIndexState {
settings?: IndicesIndexSettings
defaults?: IndicesIndexSettings
data_stream?: DataStreamName
lifecycle?: IndicesDataLifecycle
lifecycle?: IndicesDataStreamLifecycle
}

export interface IndicesIndexTemplate {
Expand All @@ -9847,7 +9847,7 @@ export interface IndicesIndexTemplateSummary {
aliases?: Record<IndexName, IndicesAlias>
mappings?: MappingTypeMapping
settings?: IndicesIndexSettings
lifecycle?: IndicesDataLifecycleWithRollover
lifecycle?: IndicesDataStreamLifecycleWithRollover
}

export interface IndicesIndexVersioning {
Expand Down Expand Up @@ -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<UnitMillis>
time_since_index_creation?: Duration
rollover_date_millis?: EpochTime<UnitMillis>
time_since_rollover?: Duration
lifecycle?: IndicesDataLifecycleWithRollover
lifecycle?: IndicesDataStreamLifecycleWithRollover
generation_time?: Duration
error?: string
}
Expand All @@ -10390,7 +10390,7 @@ export interface IndicesExplainDataLifecycleRequest extends RequestBase {
}

export interface IndicesExplainDataLifecycleResponse {
indices: Record<IndexName, IndicesExplainDataLifecycleDataLifecycleExplain>
indices: Record<IndexName, IndicesExplainDataLifecycleDataStreamLifecycleExplain>
}

export interface IndicesFieldUsageStatsFieldSummary {
Expand Down Expand Up @@ -10510,9 +10510,9 @@ export interface IndicesGetAliasRequest extends RequestBase {

export type IndicesGetAliasResponse = Record<IndexName, IndicesGetAliasIndexAliases>

export interface IndicesGetDataLifecycleDataStreamLifecycle {
export interface IndicesGetDataLifecycleDataStreamWithLifecycle {
name: DataStreamName
lifecycle?: IndicesDataLifecycle
lifecycle?: IndicesDataStreamLifecycle
}

export interface IndicesGetDataLifecycleRequest extends RequestBase {
Expand All @@ -10522,7 +10522,7 @@ export interface IndicesGetDataLifecycleRequest extends RequestBase {
}

export interface IndicesGetDataLifecycleResponse {
data_streams: IndicesGetDataLifecycleDataStreamLifecycle[]
data_streams: IndicesGetDataLifecycleDataStreamWithLifecycle[]
}

export interface IndicesGetDataStreamRequest extends RequestBase {
Expand Down Expand Up @@ -10687,7 +10687,7 @@ export interface IndicesPutIndexTemplateIndexTemplateMapping {
aliases?: Record<IndexName, IndicesAlias>
mappings?: MappingTypeMapping
settings?: IndicesIndexSettings
lifecycle?: IndicesDataLifecycle
lifecycle?: IndicesDataStreamLifecycle
}

export interface IndicesPutIndexTemplateRequest extends RequestBase {
Expand Down