1
2
3[[Elasticsearch_Namespaces_CcrNamespace]]
4=== Elasticsearch\Namespaces\CcrNamespace
5
6
7
8Class CcrNamespace
9
10*Description*
11
12
13NOTE: this file is autogenerated using util/GenerateEndpoints.php
14and Elasticsearch 7.12.1 (3186837139b9c6b6d23c3200870651f10d3343b7)
15
16
17*Methods*
18
19The class defines the following methods:
20
21* <<Elasticsearch_Namespaces_CcrNamespacedeleteAutoFollowPattern_deleteAutoFollowPattern,`deleteAutoFollowPattern()`>>
22* <<Elasticsearch_Namespaces_CcrNamespacefollow_follow,`follow()`>>
23* <<Elasticsearch_Namespaces_CcrNamespacefollowInfo_followInfo,`followInfo()`>>
24* <<Elasticsearch_Namespaces_CcrNamespacefollowStats_followStats,`followStats()`>>
25* <<Elasticsearch_Namespaces_CcrNamespaceforgetFollower_forgetFollower,`forgetFollower()`>>
26* <<Elasticsearch_Namespaces_CcrNamespacegetAutoFollowPattern_getAutoFollowPattern,`getAutoFollowPattern()`>>
27* <<Elasticsearch_Namespaces_CcrNamespacepauseAutoFollowPattern_pauseAutoFollowPattern,`pauseAutoFollowPattern()`>>
28* <<Elasticsearch_Namespaces_CcrNamespacepauseFollow_pauseFollow,`pauseFollow()`>>
29* <<Elasticsearch_Namespaces_CcrNamespaceputAutoFollowPattern_putAutoFollowPattern,`putAutoFollowPattern()`>>
30* <<Elasticsearch_Namespaces_CcrNamespaceresumeAutoFollowPattern_resumeAutoFollowPattern,`resumeAutoFollowPattern()`>>
31* <<Elasticsearch_Namespaces_CcrNamespaceresumeFollow_resumeFollow,`resumeFollow()`>>
32* <<Elasticsearch_Namespaces_CcrNamespacestats_stats,`stats()`>>
33* <<Elasticsearch_Namespaces_CcrNamespaceunfollow_unfollow,`unfollow()`>>
34
35
36
37[[Elasticsearch_Namespaces_CcrNamespacedeleteAutoFollowPattern_deleteAutoFollowPattern]]
38.`deleteAutoFollowPattern(array $params = [])`
39****
40[source,php]
41----
42/*
43$params['name'] = (string) The name of the auto follow pattern.
44*/
45----
46****
47
48
49
50[[Elasticsearch_Namespaces_CcrNamespacefollow_follow]]
51.`follow(array $params = [])`
52****
53[source,php]
54----
55/*
56$params['index']                  = (string) The name of the follower index
57$params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before returning. Defaults to 0. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) (Default = 0)
58$params['body']                   = (array) The name of the leader index and other optional ccr related parameters (Required)
59*/
60----
61****
62
63
64
65[[Elasticsearch_Namespaces_CcrNamespacefollowInfo_followInfo]]
66.`followInfo(array $params = [])`
67****
68[source,php]
69----
70/*
71$params['index'] = (list) A comma-separated list of index patterns; use `_all` to perform the operation on all indices
72*/
73----
74****
75
76
77
78[[Elasticsearch_Namespaces_CcrNamespacefollowStats_followStats]]
79.`followStats(array $params = [])`
80****
81[source,php]
82----
83/*
84$params['index'] = (list) A comma-separated list of index patterns; use `_all` to perform the operation on all indices
85*/
86----
87****
88
89
90
91[[Elasticsearch_Namespaces_CcrNamespaceforgetFollower_forgetFollower]]
92.`forgetFollower(array $params = [])`
93****
94[source,php]
95----
96/*
97$params['index'] = (string) the name of the leader index for which specified follower retention leases should be removed
98$params['body']  = (array) the name and UUID of the follower index, the name of the cluster containing the follower index, and the alias from the perspective of that cluster for the remote cluster containing the leader index (Required)
99*/
100----
101****
102
103
104
105[[Elasticsearch_Namespaces_CcrNamespacegetAutoFollowPattern_getAutoFollowPattern]]
106.`getAutoFollowPattern(array $params = [])`
107****
108[source,php]
109----
110/*
111$params['name'] = (string) The name of the auto follow pattern.
112*/
113----
114****
115
116
117
118[[Elasticsearch_Namespaces_CcrNamespacepauseAutoFollowPattern_pauseAutoFollowPattern]]
119.`pauseAutoFollowPattern(array $params = [])`
120****
121[source,php]
122----
123/*
124$params['name'] = (string) The name of the auto follow pattern that should pause discovering new indices to follow.
125*/
126----
127****
128
129
130
131[[Elasticsearch_Namespaces_CcrNamespacepauseFollow_pauseFollow]]
132.`pauseFollow(array $params = [])`
133****
134[source,php]
135----
136/*
137$params['index'] = (string) The name of the follower index that should pause following its leader index.
138*/
139----
140****
141
142
143
144[[Elasticsearch_Namespaces_CcrNamespaceputAutoFollowPattern_putAutoFollowPattern]]
145.`putAutoFollowPattern(array $params = [])`
146****
147[source,php]
148----
149/*
150$params['name'] = (string) The name of the auto follow pattern.
151*/
152----
153****
154
155
156
157[[Elasticsearch_Namespaces_CcrNamespaceresumeAutoFollowPattern_resumeAutoFollowPattern]]
158.`resumeAutoFollowPattern(array $params = [])`
159****
160[source,php]
161----
162/*
163$params['name'] = (string) The name of the auto follow pattern to resume discovering new indices to follow.
164*/
165----
166****
167
168
169
170[[Elasticsearch_Namespaces_CcrNamespaceresumeFollow_resumeFollow]]
171.`resumeFollow(array $params = [])`
172****
173[source,php]
174----
175/*
176$params['index'] = (string) The name of the follow index to resume following.
177*/
178----
179****
180
181
182
183[[Elasticsearch_Namespaces_CcrNamespacestats_stats]]
184.`stats(array $params = [])`
185****
186[source,php]
187----
188/*
189*/
190----
191****
192
193
194
195[[Elasticsearch_Namespaces_CcrNamespaceunfollow_unfollow]]
196.`unfollow(array $params = [])`
197****
198[source,php]
199----
200/*
201$params['index'] = (string) The name of the follower index that should be turned into a regular index.
202*/
203----
204****
205
206
207