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

66 lines
4.1 KiB
Plaintext

[[reference-snapshot-clone]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.clone
Clones indices from one snapshot into another snapshot in the same repository.
{ref}/modules-snapshots.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(SnapshotCloneRequest, options?): Promise<SnapshotCloneResponse>
----
[discrete]
===== `SnapshotCloneRequest`
[source,ts]
----
interface SnapshotCloneRequest extends <<shared-type-request-base, RequestBase>> {
repository: <<shared-type-name, Name>>
snapshot: <<shared-type-name, Name>>
target_snapshot: <<shared-type-name, Name>>
master_timeout?: <<shared-type-duration, Duration>>
timeout?: <<shared-type-duration, Duration>>
indices: string
}
----
[discrete]
===== `SnapshotCloneResponse`
[source,ts]
----
type SnapshotCloneResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
----