habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Auto-generated code for main (#1984)

Browse Source
This commit is contained in:
Elastic Machine
2023-08-25 00:23:40 +09:30
committed by GitHub
parent 56b4a380c1
commit 9da7c44bb0
4 changed files with 73 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/reference.asciidoc
View File

@ -3335,9 +3335,9 @@ If no response is received before the timeout expires, the request fails and ret
[discrete] [discrete]
==== delete_data_lifecycle ==== 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] [source,ts]
---- ----
client.indices.deleteDataLifecycle({ name }) client.indices.deleteDataLifecycle({ name })
@ -3347,7 +3347,7 @@ client.indices.deleteDataLifecycle({ name })
==== Arguments ==== Arguments
* *Request (object):* * *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) ** *`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 ** *`master_timeout` (Optional, string | -1 | 0)*: Specify timeout for connection to master
** *`timeout` (Optional, string | -1 | 0)*: Explicit timestamp for the document ** *`timeout` (Optional, string | -1 | 0)*: Explicit timestamp for the document
@ -3544,9 +3544,9 @@ client.indices.existsTemplate({ name })
[discrete] [discrete]
==== explain_data_lifecycle ==== 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] [source,ts]
---- ----
client.indices.explainDataLifecycle({ index }) client.indices.explainDataLifecycle({ index })
@ -3701,9 +3701,9 @@ Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
[discrete] [discrete]
==== get_data_lifecycle ==== 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] [source,ts]
---- ----
client.indices.getDataLifecycle({ name }) client.indices.getDataLifecycle({ name })
@ -3995,9 +3995,9 @@ If no response is received before the timeout expires, the request fails and ret
[discrete] [discrete]
==== put_data_lifecycle ==== 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] [source,ts]
---- ----
client.indices.putDataLifecycle({ name }) client.indices.putDataLifecycle({ name })

16
src/api/api/indices.ts
View File

@ -371,8 +371,8 @@ export default class Indices {
} }
/** /**
* Deletes the data lifecycle of the selected data streams. * Deletes the data stream lifecycle of the selected data streams.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/dlm-delete-lifecycle.html | Elasticsearch API documentation} * @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?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesDeleteDataLifecycleResponse>
async deleteDataLifecycle (this: That, params: T.IndicesDeleteDataLifecycleRequest | TB.IndicesDeleteDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesDeleteDataLifecycleResponse, unknown>> async deleteDataLifecycle (this: That, params: T.IndicesDeleteDataLifecycleRequest | TB.IndicesDeleteDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesDeleteDataLifecycleResponse, unknown>>
@ -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. * 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/dlm-explain-lifecycle.html | Elasticsearch API documentation} * @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?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesExplainDataLifecycleResponse>
async explainDataLifecycle (this: That, params: T.IndicesExplainDataLifecycleRequest | TB.IndicesExplainDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesExplainDataLifecycleResponse, unknown>> async explainDataLifecycle (this: That, params: T.IndicesExplainDataLifecycleRequest | TB.IndicesExplainDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesExplainDataLifecycleResponse, unknown>>
@ -829,8 +829,8 @@ export default class Indices {
} }
/** /**
* Returns the data lifecycle of the selected data streams. * Returns the data stream lifecycle of the selected data streams.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/dlm-get-lifecycle.html | Elasticsearch API documentation} * @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?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesGetDataLifecycleResponse>
async getDataLifecycle (this: That, params: T.IndicesGetDataLifecycleRequest | TB.IndicesGetDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesGetDataLifecycleResponse, unknown>> async getDataLifecycle (this: That, params: T.IndicesGetDataLifecycleRequest | TB.IndicesGetDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesGetDataLifecycleResponse, unknown>>
@ -1225,8 +1225,8 @@ export default class Indices {
} }
/** /**
* Updates the data lifecycle of the selected data streams. * Updates the data stream lifecycle of the selected data streams.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/dlm-put-lifecycle.html | Elasticsearch API documentation} * @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?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesPutDataLifecycleResponse>
async putDataLifecycle (this: That, params: T.IndicesPutDataLifecycleRequest | TB.IndicesPutDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesPutDataLifecycleResponse, unknown>> async putDataLifecycle (this: That, params: T.IndicesPutDataLifecycleRequest | TB.IndicesPutDataLifecycleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesPutDataLifecycleResponse, unknown>>

56
src/api/types.ts
View File

@ -8232,7 +8232,7 @@ export interface ClusterComponentTemplateSummary {
settings?: Record<IndexName, IndicesIndexSettings> settings?: Record<IndexName, IndicesIndexSettings>
mappings?: MappingTypeMapping mappings?: MappingTypeMapping
aliases?: Record<string, IndicesAliasDefinition> aliases?: Record<string, IndicesAliasDefinition>
lifecycle?: IndicesDataLifecycleWithRollover lifecycle?: IndicesDataStreamLifecycleWithRollover
} }
export interface ClusterAllocationExplainAllocationDecision { export interface ClusterAllocationExplainAllocationDecision {
@ -9496,15 +9496,6 @@ export interface IndicesCacheQueries {
enabled: boolean enabled: boolean
} }
export interface IndicesDataLifecycle {
data_retention?: Duration
}
export interface IndicesDataLifecycleWithRollover {
data_retention?: Duration
rollover?: IndicesDlmRolloverConditions
}
export interface IndicesDataStream { export interface IndicesDataStream {
_meta?: Metadata _meta?: Metadata
allow_custom_routing?: boolean allow_custom_routing?: boolean
@ -9512,7 +9503,7 @@ export interface IndicesDataStream {
hidden: boolean hidden: boolean
ilm_policy?: Name ilm_policy?: Name
indices: IndicesDataStreamIndex[] indices: IndicesDataStreamIndex[]
lifecycle?: IndicesDataLifecycleWithRollover lifecycle?: IndicesDataStreamLifecycleWithRollover
name: DataStreamName name: DataStreamName
replicated?: boolean replicated?: boolean
status: HealthStatus status: HealthStatus
@ -9526,15 +9517,11 @@ export interface IndicesDataStreamIndex {
index_uuid: Uuid index_uuid: Uuid
} }
export interface IndicesDataStreamTimestampField { export interface IndicesDataStreamLifecycle {
name: Field data_retention?: Duration
} }
export interface IndicesDataStreamVisibility { export interface IndicesDataStreamLifecycleRolloverConditions {
hidden?: boolean
}
export interface IndicesDlmRolloverConditions {
min_age?: Duration min_age?: Duration
max_age?: string max_age?: string
min_docs?: long min_docs?: long
@ -9547,6 +9534,19 @@ export interface IndicesDlmRolloverConditions {
max_primary_shard_docs?: long 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 { export interface IndicesDownsampleConfig {
fixed_interval: DurationLarge fixed_interval: DurationLarge
} }
@ -9701,7 +9701,7 @@ export interface IndicesIndexState {
settings?: IndicesIndexSettings settings?: IndicesIndexSettings
defaults?: IndicesIndexSettings defaults?: IndicesIndexSettings
data_stream?: DataStreamName data_stream?: DataStreamName
lifecycle?: IndicesDataLifecycle lifecycle?: IndicesDataStreamLifecycle
} }
export interface IndicesIndexTemplate { export interface IndicesIndexTemplate {
@ -9724,7 +9724,7 @@ export interface IndicesIndexTemplateSummary {
aliases?: Record<IndexName, IndicesAlias> aliases?: Record<IndexName, IndicesAlias>
mappings?: MappingTypeMapping mappings?: MappingTypeMapping
settings?: IndicesIndexSettings settings?: IndicesIndexSettings
lifecycle?: IndicesDataLifecycleWithRollover lifecycle?: IndicesDataStreamLifecycleWithRollover
} }
export interface IndicesIndexVersioning { export interface IndicesIndexVersioning {
@ -10238,14 +10238,14 @@ export interface IndicesExistsTemplateRequest extends RequestBase {
export type IndicesExistsTemplateResponse = boolean export type IndicesExistsTemplateResponse = boolean
export interface IndicesExplainDataLifecycleDataLifecycleExplain { export interface IndicesExplainDataLifecycleDataStreamLifecycleExplain {
index: IndexName index: IndexName
managed_by_dlm: boolean managed_by_lifecycle: boolean
index_creation_date_millis?: EpochTime<UnitMillis> index_creation_date_millis?: EpochTime<UnitMillis>
time_since_index_creation?: Duration time_since_index_creation?: Duration
rollover_date_millis?: EpochTime<UnitMillis> rollover_date_millis?: EpochTime<UnitMillis>
time_since_rollover?: Duration time_since_rollover?: Duration
lifecycle?: IndicesDataLifecycleWithRollover lifecycle?: IndicesDataStreamLifecycleWithRollover
generation_time?: Duration generation_time?: Duration
error?: string error?: string
} }
@ -10257,7 +10257,7 @@ export interface IndicesExplainDataLifecycleRequest extends RequestBase {
} }
export interface IndicesExplainDataLifecycleResponse { export interface IndicesExplainDataLifecycleResponse {
indices: Record<IndexName, IndicesExplainDataLifecycleDataLifecycleExplain> indices: Record<IndexName, IndicesExplainDataLifecycleDataStreamLifecycleExplain>
} }
export interface IndicesFieldUsageStatsFieldSummary { export interface IndicesFieldUsageStatsFieldSummary {
@ -10377,9 +10377,9 @@ export interface IndicesGetAliasRequest extends RequestBase {
export type IndicesGetAliasResponse = Record<IndexName, IndicesGetAliasIndexAliases> export type IndicesGetAliasResponse = Record<IndexName, IndicesGetAliasIndexAliases>
export interface IndicesGetDataLifecycleDataStreamLifecycle { export interface IndicesGetDataLifecycleDataStreamWithLifecycle {
name: DataStreamName name: DataStreamName
lifecycle?: IndicesDataLifecycle lifecycle?: IndicesDataStreamLifecycle
} }
export interface IndicesGetDataLifecycleRequest extends RequestBase { export interface IndicesGetDataLifecycleRequest extends RequestBase {
@ -10389,7 +10389,7 @@ export interface IndicesGetDataLifecycleRequest extends RequestBase {
} }
export interface IndicesGetDataLifecycleResponse { export interface IndicesGetDataLifecycleResponse {
data_streams: IndicesGetDataLifecycleDataStreamLifecycle[] data_streams: IndicesGetDataLifecycleDataStreamWithLifecycle[]
} }
export interface IndicesGetDataStreamRequest extends RequestBase { export interface IndicesGetDataStreamRequest extends RequestBase {
@ -10545,7 +10545,7 @@ export interface IndicesPutIndexTemplateIndexTemplateMapping {
aliases?: Record<IndexName, IndicesAlias> aliases?: Record<IndexName, IndicesAlias>
mappings?: MappingTypeMapping mappings?: MappingTypeMapping
settings?: IndicesIndexSettings settings?: IndicesIndexSettings
lifecycle?: IndicesDataLifecycle lifecycle?: IndicesDataStreamLifecycle
} }
export interface IndicesPutIndexTemplateRequest extends RequestBase { export interface IndicesPutIndexTemplateRequest extends RequestBase {

56
src/api/typesWithBodyKey.ts
View File

@ -8321,7 +8321,7 @@ export interface ClusterComponentTemplateSummary {
settings?: Record<IndexName, IndicesIndexSettings> settings?: Record<IndexName, IndicesIndexSettings>
mappings?: MappingTypeMapping mappings?: MappingTypeMapping
aliases?: Record<string, IndicesAliasDefinition> aliases?: Record<string, IndicesAliasDefinition>
lifecycle?: IndicesDataLifecycleWithRollover lifecycle?: IndicesDataStreamLifecycleWithRollover
} }
export interface ClusterAllocationExplainAllocationDecision { export interface ClusterAllocationExplainAllocationDecision {
@ -9619,15 +9619,6 @@ export interface IndicesCacheQueries {
enabled: boolean enabled: boolean
} }
export interface IndicesDataLifecycle {
data_retention?: Duration
}
export interface IndicesDataLifecycleWithRollover {
data_retention?: Duration
rollover?: IndicesDlmRolloverConditions
}
export interface IndicesDataStream { export interface IndicesDataStream {
_meta?: Metadata _meta?: Metadata
allow_custom_routing?: boolean allow_custom_routing?: boolean
@ -9635,7 +9626,7 @@ export interface IndicesDataStream {
hidden: boolean hidden: boolean
ilm_policy?: Name ilm_policy?: Name
indices: IndicesDataStreamIndex[] indices: IndicesDataStreamIndex[]
lifecycle?: IndicesDataLifecycleWithRollover lifecycle?: IndicesDataStreamLifecycleWithRollover
name: DataStreamName name: DataStreamName
replicated?: boolean replicated?: boolean
status: HealthStatus status: HealthStatus
@ -9649,15 +9640,11 @@ export interface IndicesDataStreamIndex {
index_uuid: Uuid index_uuid: Uuid
} }
export interface IndicesDataStreamTimestampField { export interface IndicesDataStreamLifecycle {
name: Field data_retention?: Duration
} }
export interface IndicesDataStreamVisibility { export interface IndicesDataStreamLifecycleRolloverConditions {
hidden?: boolean
}
export interface IndicesDlmRolloverConditions {
min_age?: Duration min_age?: Duration
max_age?: string max_age?: string
min_docs?: long min_docs?: long
@ -9670,6 +9657,19 @@ export interface IndicesDlmRolloverConditions {
max_primary_shard_docs?: long 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 { export interface IndicesDownsampleConfig {
fixed_interval: DurationLarge fixed_interval: DurationLarge
} }
@ -9824,7 +9824,7 @@ export interface IndicesIndexState {
settings?: IndicesIndexSettings settings?: IndicesIndexSettings
defaults?: IndicesIndexSettings defaults?: IndicesIndexSettings
data_stream?: DataStreamName data_stream?: DataStreamName
lifecycle?: IndicesDataLifecycle lifecycle?: IndicesDataStreamLifecycle
} }
export interface IndicesIndexTemplate { export interface IndicesIndexTemplate {
@ -9847,7 +9847,7 @@ export interface IndicesIndexTemplateSummary {
aliases?: Record<IndexName, IndicesAlias> aliases?: Record<IndexName, IndicesAlias>
mappings?: MappingTypeMapping mappings?: MappingTypeMapping
settings?: IndicesIndexSettings settings?: IndicesIndexSettings
lifecycle?: IndicesDataLifecycleWithRollover lifecycle?: IndicesDataStreamLifecycleWithRollover
} }
export interface IndicesIndexVersioning { export interface IndicesIndexVersioning {
@ -10371,14 +10371,14 @@ export interface IndicesExistsTemplateRequest extends RequestBase {
export type IndicesExistsTemplateResponse = boolean export type IndicesExistsTemplateResponse = boolean
export interface IndicesExplainDataLifecycleDataLifecycleExplain { export interface IndicesExplainDataLifecycleDataStreamLifecycleExplain {
index: IndexName index: IndexName
managed_by_dlm: boolean managed_by_lifecycle: boolean
index_creation_date_millis?: EpochTime<UnitMillis> index_creation_date_millis?: EpochTime<UnitMillis>
time_since_index_creation?: Duration time_since_index_creation?: Duration
rollover_date_millis?: EpochTime<UnitMillis> rollover_date_millis?: EpochTime<UnitMillis>
time_since_rollover?: Duration time_since_rollover?: Duration
lifecycle?: IndicesDataLifecycleWithRollover lifecycle?: IndicesDataStreamLifecycleWithRollover
generation_time?: Duration generation_time?: Duration
error?: string error?: string
} }
@ -10390,7 +10390,7 @@ export interface IndicesExplainDataLifecycleRequest extends RequestBase {
} }
export interface IndicesExplainDataLifecycleResponse { export interface IndicesExplainDataLifecycleResponse {
indices: Record<IndexName, IndicesExplainDataLifecycleDataLifecycleExplain> indices: Record<IndexName, IndicesExplainDataLifecycleDataStreamLifecycleExplain>
} }
export interface IndicesFieldUsageStatsFieldSummary { export interface IndicesFieldUsageStatsFieldSummary {
@ -10510,9 +10510,9 @@ export interface IndicesGetAliasRequest extends RequestBase {
export type IndicesGetAliasResponse = Record<IndexName, IndicesGetAliasIndexAliases> export type IndicesGetAliasResponse = Record<IndexName, IndicesGetAliasIndexAliases>
export interface IndicesGetDataLifecycleDataStreamLifecycle { export interface IndicesGetDataLifecycleDataStreamWithLifecycle {
name: DataStreamName name: DataStreamName
lifecycle?: IndicesDataLifecycle lifecycle?: IndicesDataStreamLifecycle
} }
export interface IndicesGetDataLifecycleRequest extends RequestBase { export interface IndicesGetDataLifecycleRequest extends RequestBase {
@ -10522,7 +10522,7 @@ export interface IndicesGetDataLifecycleRequest extends RequestBase {
} }
export interface IndicesGetDataLifecycleResponse { export interface IndicesGetDataLifecycleResponse {
data_streams: IndicesGetDataLifecycleDataStreamLifecycle[] data_streams: IndicesGetDataLifecycleDataStreamWithLifecycle[]
} }
export interface IndicesGetDataStreamRequest extends RequestBase { export interface IndicesGetDataStreamRequest extends RequestBase {
@ -10687,7 +10687,7 @@ export interface IndicesPutIndexTemplateIndexTemplateMapping {
aliases?: Record<IndexName, IndicesAlias> aliases?: Record<IndexName, IndicesAlias>
mappings?: MappingTypeMapping mappings?: MappingTypeMapping
settings?: IndicesIndexSettings settings?: IndicesIndexSettings
lifecycle?: IndicesDataLifecycle lifecycle?: IndicesDataStreamLifecycle
} }
export interface IndicesPutIndexTemplateRequest extends RequestBase { export interface IndicesPutIndexTemplateRequest extends RequestBase {