Skip to content

Commit 630cb0b

Browse files
ezimuelezimuel
committed
Updated endpoints to 8.2
1 parent 8d245bc commit 630cb0b

31 files changed

+958
-184
lines changed

‎src/Endpoints/AsyncSearch.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,6 @@ public function status(array $params = [])
192192
* body: array, // The search definition using the Query DSL
193193
* } $params
194194
*
195-
* @throws MissingParameterException if a required parameter is missing
196195
* @throws NoNodeAvailableException if all the hosts are offline
197196
* @throws ClientResponseException if the status code of response is 4xx
198197
* @throws ServerResponseException if the status code of response is 5xx

‎src/Endpoints/Autoscaling.php

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,20 @@ public function deleteAutoscalingPolicy(array $params = [])
6767
* Gets the current autoscaling capacity based on the configured autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
6868
*
6969
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-capacity.html
70+
*
71+
* @param array{
72+
* pretty: boolean, // Pretty format the returned JSON response. (DEFAULT: false)
73+
* human: boolean, // Return human readable values for statistics. (DEFAULT: true)
74+
* error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false)
75+
* source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
76+
* filter_path: list, // A comma-separated list of filters used to reduce the response.
77+
* } $params
78+
*
79+
* @throws NoNodeAvailableException if all the hosts are offline
80+
* @throws ClientResponseException if the status code of response is 4xx
81+
* @throws ServerResponseException if the status code of response is 5xx
82+
*
83+
* @return Elasticsearch|Promise
7084
*/
7185
public function getAutoscalingCapacity(array $params = [])
7286
{

‎src/Endpoints/Cat.php

Lines changed: 68 additions & 49 deletions
Large diffs are not rendered by default.

‎src/Endpoints/Ccr.php

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,6 @@ public function forgetFollower(array $params = [])
222222
* filter_path: list, // A comma-separated list of filters used to reduce the response.
223223
* } $params
224224
*
225-
* @throws MissingParameterException if a required parameter is missing
226225
* @throws NoNodeAvailableException if all the hosts are offline
227226
* @throws ClientResponseException if the status code of response is 4xx
228227
* @throws ServerResponseException if the status code of response is 5xx
@@ -429,6 +428,20 @@ public function resumeFollow(array $params = [])
429428
* Gets all stats related to cross-cluster replication.
430429
*
431430
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-stats.html
431+
*
432+
* @param array{
433+
* pretty: boolean, // Pretty format the returned JSON response. (DEFAULT: false)
434+
* human: boolean, // Return human readable values for statistics. (DEFAULT: true)
435+
* error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false)
436+
* source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
437+
* filter_path: list, // A comma-separated list of filters used to reduce the response.
438+
* } $params
439+
*
440+
* @throws NoNodeAvailableException if all the hosts are offline
441+
* @throws ClientResponseException if the status code of response is 4xx
442+
* @throws ServerResponseException if the status code of response is 5xx
443+
*
444+
* @return Elasticsearch|Promise
432445
*/
433446
public function stats(array $params = [])
434447
{

‎src/Endpoints/Cluster.php

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@ class Cluster extends AbstractEndpoint
4444
* body: array, // The index, shard, and primary flag to explain. Empty means 'explain a randomly-chosen unassigned shard'
4545
* } $params
4646
*
47-
* @throws MissingParameterException if a required parameter is missing
4847
* @throws NoNodeAvailableException if all the hosts are offline
4948
* @throws ClientResponseException if the status code of response is 4xx
5049
* @throws ServerResponseException if the status code of response is 5xx
@@ -116,7 +115,6 @@ public function deleteComponentTemplate(array $params = [])
116115
* filter_path: list, // A comma-separated list of filters used to reduce the response.
117116
* } $params
118117
*
119-
* @throws MissingParameterException if a required parameter is missing
120118
* @throws NoNodeAvailableException if all the hosts are offline
121119
* @throws ClientResponseException if the status code of response is 4xx
122120
* @throws ServerResponseException if the status code of response is 5xx
@@ -189,7 +187,6 @@ public function existsComponentTemplate(array $params = [])
189187
* filter_path: list, // A comma-separated list of filters used to reduce the response.
190188
* } $params
191189
*
192-
* @throws MissingParameterException if a required parameter is missing
193190
* @throws NoNodeAvailableException if all the hosts are offline
194191
* @throws ClientResponseException if the status code of response is 4xx
195192
* @throws ServerResponseException if the status code of response is 5xx
@@ -230,7 +227,6 @@ public function getComponentTemplate(array $params = [])
230227
* filter_path: list, // A comma-separated list of filters used to reduce the response.
231228
* } $params
232229
*
233-
* @throws MissingParameterException if a required parameter is missing
234230
* @throws NoNodeAvailableException if all the hosts are offline
235231
* @throws ClientResponseException if the status code of response is 4xx
236232
* @throws ServerResponseException if the status code of response is 5xx
@@ -275,7 +271,6 @@ public function getSettings(array $params = [])
275271
* filter_path: list, // A comma-separated list of filters used to reduce the response.
276272
* } $params
277273
*
278-
* @throws MissingParameterException if a required parameter is missing
279274
* @throws NoNodeAvailableException if all the hosts are offline
280275
* @throws ClientResponseException if the status code of response is 4xx
281276
* @throws ServerResponseException if the status code of response is 5xx
@@ -315,7 +310,6 @@ public function health(array $params = [])
315310
* filter_path: list, // A comma-separated list of filters used to reduce the response.
316311
* } $params
317312
*
318-
* @throws MissingParameterException if a required parameter is missing
319313
* @throws NoNodeAvailableException if all the hosts are offline
320314
* @throws ClientResponseException if the status code of response is 4xx
321315
* @throws ServerResponseException if the status code of response is 5xx
@@ -351,7 +345,6 @@ public function pendingTasks(array $params = [])
351345
* filter_path: list, // A comma-separated list of filters used to reduce the response.
352346
* } $params
353347
*
354-
* @throws MissingParameterException if a required parameter is missing
355348
* @throws NoNodeAvailableException if all the hosts are offline
356349
* @throws ClientResponseException if the status code of response is 4xx
357350
* @throws ServerResponseException if the status code of response is 5xx
@@ -428,7 +421,6 @@ public function putComponentTemplate(array $params = [])
428421
* body: array, // (REQUIRED) The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart).
429422
* } $params
430423
*
431-
* @throws MissingParameterException if a required parameter is missing
432424
* @throws NoNodeAvailableException if all the hosts are offline
433425
* @throws ClientResponseException if the status code of response is 4xx
434426
* @throws ServerResponseException if the status code of response is 5xx
@@ -454,6 +446,20 @@ public function putSettings(array $params = [])
454446
* Returns the information about configured remote clusters.
455447
*
456448
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html
449+
*
450+
* @param array{
451+
* pretty: boolean, // Pretty format the returned JSON response. (DEFAULT: false)
452+
* human: boolean, // Return human readable values for statistics. (DEFAULT: true)
453+
* error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false)
454+
* source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
455+
* filter_path: list, // A comma-separated list of filters used to reduce the response.
456+
* } $params
457+
*
458+
* @throws NoNodeAvailableException if all the hosts are offline
459+
* @throws ClientResponseException if the status code of response is 4xx
460+
* @throws ServerResponseException if the status code of response is 5xx
461+
*
462+
* @return Elasticsearch|Promise
457463
*/
458464
public function remoteInfo(array $params = [])
459465
{
@@ -488,7 +494,6 @@ public function remoteInfo(array $params = [])
488494
* body: array, // The definition of `commands` to perform (`move`, `cancel`, `allocate`)
489495
* } $params
490496
*
491-
* @throws MissingParameterException if a required parameter is missing
492497
* @throws NoNodeAvailableException if all the hosts are offline
493498
* @throws ClientResponseException if the status code of response is 4xx
494499
* @throws ServerResponseException if the status code of response is 5xx
@@ -532,7 +537,6 @@ public function reroute(array $params = [])
532537
* filter_path: list, // A comma-separated list of filters used to reduce the response.
533538
* } $params
534539
*
535-
* @throws MissingParameterException if a required parameter is missing
536540
* @throws NoNodeAvailableException if all the hosts are offline
537541
* @throws ClientResponseException if the status code of response is 4xx
538542
* @throws ServerResponseException if the status code of response is 5xx
@@ -575,7 +579,6 @@ public function state(array $params = [])
575579
* filter_path: list, // A comma-separated list of filters used to reduce the response.
576580
* } $params
577581
*
578-
* @throws MissingParameterException if a required parameter is missing
579582
* @throws NoNodeAvailableException if all the hosts are offline
580583
* @throws ClientResponseException if the status code of response is 4xx
581584
* @throws ServerResponseException if the status code of response is 5xx

‎src/Endpoints/DanglingIndices.php

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,20 @@ public function importDanglingIndex(array $params = [])
108108
* Returns all dangling indices.
109109
*
110110
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html
111+
*
112+
* @param array{
113+
* pretty: boolean, // Pretty format the returned JSON response. (DEFAULT: false)
114+
* human: boolean, // Return human readable values for statistics. (DEFAULT: true)
115+
* error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false)
116+
* source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
117+
* filter_path: list, // A comma-separated list of filters used to reduce the response.
118+
* } $params
119+
*
120+
* @throws NoNodeAvailableException if all the hosts are offline
121+
* @throws ClientResponseException if the status code of response is 4xx
122+
* @throws ServerResponseException if the status code of response is 5xx
123+
*
124+
* @return Elasticsearch|Promise
111125
*/
112126
public function listDanglingIndices(array $params = [])
113127
{

‎src/Endpoints/Enrich.php

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,6 @@ public function executePolicy(array $params = [])
113113
* filter_path: list, // A comma-separated list of filters used to reduce the response.
114114
* } $params
115115
*
116-
* @throws MissingParameterException if a required parameter is missing
117116
* @throws NoNodeAvailableException if all the hosts are offline
118117
* @throws ClientResponseException if the status code of response is 4xx
119118
* @throws ServerResponseException if the status code of response is 5xx
@@ -178,6 +177,20 @@ public function putPolicy(array $params = [])
178177
* Gets enrich coordinator statistics and information about enrich policies that are currently executing.
179178
*
180179
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html
180+
*
181+
* @param array{
182+
* pretty: boolean, // Pretty format the returned JSON response. (DEFAULT: false)
183+
* human: boolean, // Return human readable values for statistics. (DEFAULT: true)
184+
* error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false)
185+
* source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
186+
* filter_path: list, // A comma-separated list of filters used to reduce the response.
187+
* } $params
188+
*
189+
* @throws NoNodeAvailableException if all the hosts are offline
190+
* @throws ClientResponseException if the status code of response is 4xx
191+
* @throws ServerResponseException if the status code of response is 5xx
192+
*
193+
* @return Elasticsearch|Promise
181194
*/
182195
public function stats(array $params = [])
183196
{

‎src/Endpoints/Features.php

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ class Features extends AbstractEndpoint
4242
* filter_path: list, // A comma-separated list of filters used to reduce the response.
4343
* } $params
4444
*
45-
* @throws MissingParameterException if a required parameter is missing
4645
* @throws NoNodeAvailableException if all the hosts are offline
4746
* @throws ClientResponseException if the status code of response is 4xx
4847
* @throws ServerResponseException if the status code of response is 5xx
@@ -67,6 +66,20 @@ public function getFeatures(array $params = [])
6766
*
6867
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html
6968
* @internal This API is EXPERIMENTAL and may be changed or removed completely in a future release
69+
*
70+
* @param array{
71+
* pretty: boolean, // Pretty format the returned JSON response. (DEFAULT: false)
72+
* human: boolean, // Return human readable values for statistics. (DEFAULT: true)
73+
* error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false)
74+
* source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
75+
* filter_path: list, // A comma-separated list of filters used to reduce the response.
76+
* } $params
77+
*
78+
* @throws NoNodeAvailableException if all the hosts are offline
79+
* @throws ClientResponseException if the status code of response is 4xx
80+
* @throws ServerResponseException if the status code of response is 5xx
81+
*
82+
* @return Elasticsearch|Promise
7083
*/
7184
public function resetFeatures(array $params = [])
7285
{

‎src/Endpoints/Fleet.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,6 @@ public function globalCheckpoints(array $params = [])
8383
* body: array, // (REQUIRED) The request definitions (metadata-fleet search request definition pairs), separated by newlines
8484
* } $params
8585
*
86-
* @throws MissingParameterException if a required parameter is missing
8786
* @throws NoNodeAvailableException if all the hosts are offline
8887
* @throws ClientResponseException if the status code of response is 4xx
8988
* @throws ServerResponseException if the status code of response is 5xx

‎src/Endpoints/Ilm.php

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,6 @@ public function explainLifecycle(array $params = [])
114114
* filter_path: list, // A comma-separated list of filters used to reduce the response.
115115
* } $params
116116
*
117-
* @throws MissingParameterException if a required parameter is missing
118117
* @throws NoNodeAvailableException if all the hosts are offline
119118
* @throws ClientResponseException if the status code of response is 4xx
120119
* @throws ServerResponseException if the status code of response is 5xx
@@ -142,6 +141,20 @@ public function getLifecycle(array $params = [])
142141
* Retrieves the current index lifecycle management (ILM) status.
143142
*
144143
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html
144+
*
145+
* @param array{
146+
* pretty: boolean, // Pretty format the returned JSON response. (DEFAULT: false)
147+
* human: boolean, // Return human readable values for statistics. (DEFAULT: true)
148+
* error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false)
149+
* source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
150+
* filter_path: list, // A comma-separated list of filters used to reduce the response.
151+
* } $params
152+
*
153+
* @throws NoNodeAvailableException if all the hosts are offline
154+
* @throws ClientResponseException if the status code of response is 4xx
155+
* @throws ServerResponseException if the status code of response is 5xx
156+
*
157+
* @return Elasticsearch|Promise
145158
*/
146159
public function getStatus(array $params = [])
147160
{
@@ -171,7 +184,6 @@ public function getStatus(array $params = [])
171184
* body: array, // Optionally specify a legacy index template name to delete and optionally specify a node attribute name used for index shard routing (defaults to "data")
172185
* } $params
173186
*
174-
* @throws MissingParameterException if a required parameter is missing
175187
* @throws NoNodeAvailableException if all the hosts are offline
176188
* @throws ClientResponseException if the status code of response is 4xx
177189
* @throws ServerResponseException if the status code of response is 5xx
@@ -340,6 +352,20 @@ public function retry(array $params = [])
340352
* Start the index lifecycle management (ILM) plugin.
341353
*
342354
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html
355+
*
356+
* @param array{
357+
* pretty: boolean, // Pretty format the returned JSON response. (DEFAULT: false)
358+
* human: boolean, // Return human readable values for statistics. (DEFAULT: true)
359+
* error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false)
360+
* source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
361+
* filter_path: list, // A comma-separated list of filters used to reduce the response.
362+
* } $params
363+
*
364+
* @throws NoNodeAvailableException if all the hosts are offline
365+
* @throws ClientResponseException if the status code of response is 4xx
366+
* @throws ServerResponseException if the status code of response is 5xx
367+
*
368+
* @return Elasticsearch|Promise
343369
*/
344370
public function start(array $params = [])
345371
{
@@ -358,6 +384,20 @@ public function start(array $params = [])
358384
* Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin
359385
*
360386
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html
387+
*
388+
* @param array{
389+
* pretty: boolean, // Pretty format the returned JSON response. (DEFAULT: false)
390+
* human: boolean, // Return human readable values for statistics. (DEFAULT: true)
391+
* error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false)
392+
* source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
393+
* filter_path: list, // A comma-separated list of filters used to reduce the response.
394+
* } $params
395+
*
396+
* @throws NoNodeAvailableException if all the hosts are offline
397+
* @throws ClientResponseException if the status code of response is 4xx
398+
* @throws ServerResponseException if the status code of response is 5xx
399+
*
400+
* @return Elasticsearch|Promise
361401
*/
362402
public function stop(array $params = [])
363403
{

0 commit comments

Comments
 (0)