habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Restructure reference docs directory

Browse Source
This commit is contained in:
Josh Mock
2024-12-02 16:58:55 -06:00
parent 647dac8069
commit c3e7619621
583 changed files with 1186 additions and 1305 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
docs/reference/ccr-forget_follower.asciidoc Normal file
View File

@ -0,0 +1,77 @@
[[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]]
=== 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]
==== Request
[pass]
++++
<pre>
++++
interface CcrForgetFollowerRequest extends <<RequestBase>> {
index: <<IndexName>>
follower_cluster?: string
follower_index?: <<IndexName>>
follower_index_uuid?: <<Uuid>>
leader_remote_cluster?: string
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
[pass]
++++
<pre>
++++
interface CcrForgetFollowerResponse {
_shards: <<ShardStatistics>>
}
[pass]
++++
</pre>
++++