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

71 lines
4.2 KiB
Plaintext

[[reference-indices-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.indices.clone
Clones an existing index.
{ref}/indices-clone-index.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(IndicesCloneRequest, options?): Promise<IndicesCloneResponse>
----
[discrete]
===== `IndicesCloneRequest`
[source,ts]
----
interface IndicesCloneRequest extends <<shared-type-request-base, RequestBase>> {
index: <<shared-type-index-name, IndexName>>
target: <<shared-type-name, Name>>
master_timeout?: <<shared-type-duration, Duration>>
timeout?: <<shared-type-duration, Duration>>
wait_for_active_shards?: <<shared-type-wait-for-active-shards, WaitForActiveShards>>
aliases?: Record<<<shared-type-index-name, IndexName>>, IndicesAlias>
settings?: Record<string, any>
}
----
[discrete]
===== `IndicesCloneResponse`
[source,ts]
----
interface IndicesCloneResponse {
acknowledged: boolean
index: <<shared-type-index-name, IndexName>>
shards_acknowledged: boolean
}
----