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

67 lines
4.1 KiB
Plaintext

[[reference-ccr-forget_follower]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.ccr.forgetFollower
Removes the follower retention leases from the leader.
{ref}/ccr-post-forget-follower.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(CcrForgetFollowerRequest, options?): Promise<CcrForgetFollowerResponse>
----
[discrete]
===== `CcrForgetFollowerRequest`
[source,ts]
----
interface CcrForgetFollowerRequest extends <<shared-type-request-base, RequestBase>> {
index: <<shared-type-index-name, IndexName>>
follower_cluster?: string
follower_index?: <<shared-type-index-name, IndexName>>
follower_index_uuid?: <<shared-type-uuid, Uuid>>
leader_remote_cluster?: string
}
----
[discrete]
===== `CcrForgetFollowerResponse`
[source,ts]
----
interface CcrForgetFollowerResponse {
_shards: <<shared-type-shard-statistics, ShardStatistics>>
}
----