76 lines
4.3 KiB
Plaintext
76 lines
4.3 KiB
Plaintext
[[reference-indices-explain_data_lifecycle]]
|
||
|
||
////////
|
||
===========================================================================================================================
|
||
|| ||
|
||
|| ||
|
||
|| ||
|
||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||
|| ||
|
||
|| ||
|
||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|
||
|| You should update the script that does the generation, which can be found in: ||
|
||
|| https://github.com/elastic/elastic-client-generator-js ||
|
||
|| ||
|
||
|| You can run the script with the following command: ||
|
||
|| npm run elasticsearch -- --version <version> ||
|
||
|| ||
|
||
|| ||
|
||
|| ||
|
||
===========================================================================================================================
|
||
////////
|
||
|
||
[discrete]
|
||
[[client.indices.explainDataLifecycle]]
|
||
=== client.indices.explainDataLifecycle
|
||
|
||
Get the status for a data stream lifecycle. Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.
|
||
|
||
{ref}/data-streams-explain-lifecycle.html[{es} documentation]
|
||
|
||
[discrete]
|
||
==== Function signature
|
||
|
||
[source,ts]
|
||
----
|
||
(IndicesExplainDataLifecycleRequest, options?): Promise<IndicesExplainDataLifecycleResponse>
|
||
----
|
||
|
||
[discrete]
|
||
==== IndicesExplainDataLifecycleRequest
|
||
|
||
[pass]
|
||
++++
|
||
<pre>
|
||
++++
|
||
interface IndicesExplainDataLifecycleRequest extends <<RequestBase>> {
|
||
index: <<Indices>>
|
||
include_defaults?: boolean
|
||
master_timeout?: <<Duration>>
|
||
}
|
||
|
||
[pass]
|
||
++++
|
||
</pre>
|
||
++++
|
||
[discrete]
|
||
==== IndicesExplainDataLifecycleResponse
|
||
|
||
[pass]
|
||
++++
|
||
<pre>
|
||
++++
|
||
interface IndicesExplainDataLifecycleResponse {
|
||
indices: Record<<<IndexName>>, IndicesExplainDataLifecycleDataStreamLifecycleExplain>
|
||
}
|
||
|
||
[pass]
|
||
++++
|
||
</pre>
|
||
++++
|