Files
elasticsearch-js/docs/reference-snapshot-create.asciidoc

84 lines
4.1 KiB
Plaintext

[[reference-snapshot-create]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.create]]
=== client.snapshot.create
Creates a snapshot in a repository.
{ref}/modules-snapshots.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(SnapshotCreateRequest, options?): Promise<SnapshotCreateResponse>
----
[discrete]
==== SnapshotCreateRequest
[pass]
++++
<pre>
++++
interface SnapshotCreateRequest extends <<RequestBase>> {
repository: <<Name>>
snapshot: <<Name>>
master_timeout?: <<Duration>>
wait_for_completion?: boolean
ignore_unavailable?: boolean
include_global_state?: boolean
indices?: <<Indices>>
feature_states?: string[]
metadata?: <<Metadata>>
partial?: boolean
}
[pass]
++++
</pre>
++++
[discrete]
==== SnapshotCreateResponse
[pass]
++++
<pre>
++++
interface SnapshotCreateResponse {
accepted?: boolean
snapshot?: <<SnapshotSnapshotInfo>>
}
[pass]
++++
</pre>
++++