66 lines
3.9 KiB
Plaintext
66 lines
3.9 KiB
Plaintext
[[reference-snapshot-status]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| 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.snapshot.status
|
|
|
|
Returns information about the status of a snapshot.
|
|
|
|
{ref}/modules-snapshots.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(SnapshotStatusRequest, options?): Promise<SnapshotStatusResponse>
|
|
----
|
|
|
|
[discrete]
|
|
===== `SnapshotStatusRequest`
|
|
|
|
[source,ts]
|
|
----
|
|
interface SnapshotStatusRequest extends <<shared-type-request-base, RequestBase>> {
|
|
repository?: <<shared-type-name, Name>>
|
|
snapshot?: <<shared-type-names, Names>>
|
|
ignore_unavailable?: boolean
|
|
master_timeout?: <<shared-type-duration, Duration>>
|
|
}
|
|
----
|
|
|
|
[discrete]
|
|
===== `SnapshotStatusResponse`
|
|
|
|
[source,ts]
|
|
----
|
|
interface SnapshotStatusResponse {
|
|
snapshots: SnapshotStatus[]
|
|
}
|
|
----
|
|
|