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

Test run of new docs

Browse Source
This commit is contained in:
Josh Mock
2024-11-19 11:04:35 -06:00
parent f33aa8cccd
commit 8210607de0
503 changed files with 37166 additions and 12056 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
docs/reference-indices-explain_data_lifecycle.asciidoc Normal file
View File

@ -0,0 +1,64 @@
[[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
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`
[source,ts]
----
interface IndicesExplainDataLifecycleRequest extends <<shared-type-request-base, RequestBase>> {
index: <<shared-type-indices, Indices>>
include_defaults?: boolean
master_timeout?: <<shared-type-duration, Duration>>
}
----
[discrete]
===== `IndicesExplainDataLifecycleResponse`
[source,ts]
----
interface IndicesExplainDataLifecycleResponse {
indices: Record<<<shared-type-index-name, IndexName>>, IndicesExplainDataLifecycleDataStreamLifecycleExplain>
}
----