Files
elasticsearch-js/docs/reference-slm-get_lifecycle.asciidoc
2024-12-05 14:46:46 -06:00

61 lines
3.9 KiB
Plaintext

[[reference-slm-get_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.slm.getLifecycle
Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.
{ref}/slm-api-get-policy.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(SlmGetLifecycleRequest, options?): Promise<SlmGetLifecycleResponse>
----
[discrete]
===== `SlmGetLifecycleRequest`
[source,ts]
----
interface SlmGetLifecycleRequest extends <<shared-type-request-base, RequestBase>> {
policy_id?: <<shared-type-names, Names>>
}
----
[discrete]
===== `SlmGetLifecycleResponse`
[source,ts]
----
type SlmGetLifecycleResponse = Record<<<shared-type-id, Id>>, SlmSnapshotLifecycle>
----