mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 23:27:25 -04:00
[HLRC] Added support for CCR Put Follow API (#35409)
This change also adds documentation for the Put Follow API and adds a CCR HLRC integration test.
This commit is contained in:
parent
7919b66e67
commit
e81671dd45
10 changed files with 808 additions and 20 deletions
39
docs/java-rest/high-level/ccr/put_follow.asciidoc
Normal file
39
docs/java-rest/high-level/ccr/put_follow.asciidoc
Normal file
|
@ -0,0 +1,39 @@
|
|||
--
|
||||
:api: ccr-put-follow
|
||||
:request: PutFollowRequest
|
||||
:response: PutFollowResponse
|
||||
--
|
||||
|
||||
[id="{upid}-{api}"]
|
||||
=== Put Follow API
|
||||
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Request
|
||||
|
||||
The Put Follow API allows creates a follower index and make that index follow a leader index.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-request]
|
||||
--------------------------------------------------
|
||||
<1> The name of the remote cluster alias.
|
||||
<2> The name of the leader in the remote cluster.
|
||||
<3> The name of the follower index that gets created as part of the put follow API call.
|
||||
|
||||
[id="{upid}-{api}-response"]
|
||||
==== Response
|
||||
|
||||
The returned +{response}+ indicates if the put follow request was received.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
||||
<1> Whether the follower index was created.
|
||||
<2> Whether the follower shards are started.
|
||||
<3> Whether the follower index started following the leader index.
|
||||
|
||||
include::../execution.asciidoc[]
|
||||
|
||||
|
|
@ -407,6 +407,8 @@ don't leak into the rest of the documentation.
|
|||
|
||||
The Java High Level REST Client supports the following CCR APIs:
|
||||
|
||||
* <<{upid}-ccr-put-follow>>
|
||||
* <<{upid}-ccr-pause-follow>>
|
||||
|
||||
include::ccr/put_follow.asciidoc[]
|
||||
include::ccr/pause_follow.asciidoc[]
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue