mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 07:37:19 -04:00
[HLRC] Added support for CCR Put Auto Follow Pattern API (#35780)
This change also adds documentation for the Put Auto Follow Pattern API. Relates to #33824
This commit is contained in:
parent
447e5d212a
commit
df1e02d0d5
8 changed files with 418 additions and 0 deletions
|
@ -0,0 +1,37 @@
|
|||
--
|
||||
:api: ccr-put-auto-follow-pattern
|
||||
:request: PutAutoFollowPatternRequest
|
||||
:response: AcknowledgedResponse
|
||||
--
|
||||
|
||||
[id="{upid}-{api}"]
|
||||
=== Put Auto Follow Pattern API
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Request
|
||||
|
||||
The Put Auto Follow Pattern API allows you to store auto follow patterns in order
|
||||
to automatically follow leader indices in a remote clusters matching certain
|
||||
index name patterns.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-request]
|
||||
--------------------------------------------------
|
||||
<1> The name of the auto follow pattern.
|
||||
<2> The name of the remote cluster.
|
||||
<3> The leader index patterns.
|
||||
<4> The pattern used to create the follower index
|
||||
|
||||
[id="{upid}-{api}-response"]
|
||||
==== Response
|
||||
|
||||
The returned +{response}+ indicates if the put auto follow pattern request was received.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
||||
<1> Whether or not the put auto follow pattern request was acknowledged.
|
||||
|
||||
include::../execution.asciidoc[]
|
|
@ -458,11 +458,13 @@ The Java High Level REST Client supports the following CCR APIs:
|
|||
* <<{upid}-ccr-pause-follow>>
|
||||
* <<{upid}-ccr-resume-follow>>
|
||||
* <<{upid}-ccr-unfollow>>
|
||||
* <<{upid}-ccr-put-auto-follow-pattern>>
|
||||
|
||||
include::ccr/put_follow.asciidoc[]
|
||||
include::ccr/pause_follow.asciidoc[]
|
||||
include::ccr/resume_follow.asciidoc[]
|
||||
include::ccr/unfollow.asciidoc[]
|
||||
include::ccr/put_auto_follow_pattern.asciidoc[]
|
||||
|
||||
== Index Lifecycle Management APIs
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue