91 lines
4.3 KiB
Plaintext
91 lines
4.3 KiB
Plaintext
[[reference-snapshot-get]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| 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.get]]
|
|
=== client.snapshot.get
|
|
|
|
Returns information about a snapshot.
|
|
|
|
{ref}/modules-snapshots.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(SnapshotGetRequest, options?): Promise<SnapshotGetResponse>
|
|
----
|
|
|
|
[discrete]
|
|
==== SnapshotGetRequest
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface SnapshotGetRequest extends <<RequestBase>> {
|
|
repository: <<Name>>
|
|
snapshot: <<Names>>
|
|
ignore_unavailable?: boolean
|
|
master_timeout?: <<Duration>>
|
|
verbose?: boolean
|
|
index_details?: boolean
|
|
index_names?: boolean
|
|
include_repository?: boolean
|
|
sort?: SnapshotSnapshotSort
|
|
size?: <<integer>>
|
|
order?: <<SortOrder>>
|
|
after?: string
|
|
offset?: <<integer>>
|
|
from_sort_value?: string
|
|
slm_policy_filter?: <<Name>>
|
|
}
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|
|
[discrete]
|
|
==== SnapshotGetResponse
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface SnapshotGetResponse {
|
|
responses?: SnapshotGetSnapshotResponseItem[]
|
|
snapshots?: SnapshotSnapshotInfo[]
|
|
total: <<integer>>
|
|
remaining: <<integer>>
|
|
}
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|