1: <?php
2:
3: declare(strict_types=1);
4:
5: /**
6: * Copyright OpenSearch Contributors
7: * SPDX-License-Identifier: Apache-2.0
8: *
9: * OpenSearch PHP client
10: *
11: * @link https://github.com/opensearch-project/opensearch-php/
12: * @copyright Copyright (c) Elasticsearch B.V (https://www.elastic.co)
13: * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
14: * @license https://www.gnu.org/licenses/lgpl-2.1.html GNU Lesser General Public License, Version 2.1
15: *
16: * Licensed to Elasticsearch B.V under one or more agreements.
17: * Elasticsearch B.V licenses this file to you under the Apache 2.0 License or
18: * the GNU Lesser General Public License, Version 2.1, at your option.
19: * See the LICENSE file in the project root for more information.
20: */
21:
22: namespace OpenSearch\Endpoints;
23:
24: use OpenSearch\Common\Exceptions\RuntimeException;
25: use OpenSearch\Endpoints\AbstractEndpoint;
26:
27: /**
28: * NOTE: This file is autogenerated using util/GenerateEndpoints.php
29: */
30: class UpdateByQueryRethrottle extends AbstractEndpoint
31: {
32: protected $task_id;
33:
34: public function getURI(): string
35: {
36: if (isset($this->task_id) !== true) {
37: throw new RuntimeException(
38: 'task_id is required for update_by_query_rethrottle'
39: );
40: }
41: $task_id = $this->task_id;
42: return "/_update_by_query/$task_id/_rethrottle";
43: }
44:
45: public function getParamWhitelist(): array
46: {
47: return [
48: 'requests_per_second',
49: 'pretty',
50: 'human',
51: 'error_trace',
52: 'source',
53: 'filter_path'
54: ];
55: }
56:
57: public function getMethod(): string
58: {
59: return 'POST';
60: }
61:
62: public function setTaskId($task_id): static
63: {
64: if (isset($task_id) !== true) {
65: return $this;
66: }
67: $this->task_id = $task_id;
68:
69: return $this;
70: }
71: }
72: