86 lines
4.4 KiB
Plaintext
86 lines
4.4 KiB
Plaintext
[[reference-ccr-follow]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| 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> ||
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
===========================================================================================================================
|
|
////////
|
|
++++
|
|
<style>
|
|
.lang-ts a.xref {
|
|
text-decoration: underline !important;
|
|
}
|
|
</style>
|
|
++++
|
|
|
|
[[client.ccr.follow]]
|
|
== client.ccr.follow
|
|
|
|
Creates a new follower index configured to follow the referenced leader index.
|
|
|
|
{ref}/ccr-put-follow.html[{es} documentation]
|
|
[discrete]
|
|
== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(CcrFollowRequest, options?): Promise<CcrFollowResponse>
|
|
----
|
|
|
|
[discrete]
|
|
=== Request
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
interface CcrFollowRequest extends <<RequestBase>> {
|
|
index: <<IndexName>>
|
|
wait_for_active_shards?: <<WaitForActiveShards>>
|
|
leader_index?: <<IndexName>>
|
|
max_outstanding_read_requests?: <<long>>
|
|
max_outstanding_write_requests?: <<long>>
|
|
max_read_request_operation_count?: <<long>>
|
|
max_read_request_size?: string
|
|
max_retry_delay?: <<Duration>>
|
|
max_write_buffer_count?: <<long>>
|
|
max_write_buffer_size?: string
|
|
max_write_request_operation_count?: <<long>>
|
|
max_write_request_size?: string
|
|
read_poll_timeout?: <<Duration>>
|
|
remote_cluster?: string
|
|
}
|
|
|
|
----
|
|
|
|
[discrete]
|
|
=== Response
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
interface CcrFollowResponse {
|
|
follow_index_created: boolean
|
|
follow_index_shards_acked: boolean
|
|
index_following_started: boolean
|
|
}
|
|
|
|
----
|
|
|