77 lines
4.3 KiB
Plaintext
77 lines
4.3 KiB
Plaintext
[[reference-snapshot-restore]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| 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.restore
|
|
|
|
Restores a snapshot.
|
|
|
|
{ref}/modules-snapshots.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(SnapshotRestoreRequest, options?): Promise<SnapshotRestoreResponse>
|
|
----
|
|
|
|
[discrete]
|
|
===== `SnapshotRestoreRequest`
|
|
|
|
[source,ts]
|
|
----
|
|
interface SnapshotRestoreRequest extends <<shared-type-request-base, RequestBase>> {
|
|
repository: <<shared-type-name, Name>>
|
|
snapshot: <<shared-type-name, Name>>
|
|
master_timeout?: <<shared-type-duration, Duration>>
|
|
wait_for_completion?: boolean
|
|
feature_states?: string[]
|
|
ignore_index_settings?: string[]
|
|
ignore_unavailable?: boolean
|
|
include_aliases?: boolean
|
|
include_global_state?: boolean
|
|
index_settings?: IndicesIndexSettings
|
|
indices?: <<shared-type-indices, Indices>>
|
|
partial?: boolean
|
|
rename_pattern?: string
|
|
rename_replacement?: string
|
|
}
|
|
----
|
|
|
|
[discrete]
|
|
===== `SnapshotRestoreResponse`
|
|
|
|
[source,ts]
|
|
----
|
|
interface SnapshotRestoreResponse {
|
|
accepted?: boolean
|
|
snapshot?: SnapshotRestoreSnapshotRestore
|
|
}
|
|
----
|
|
|