File OpenSearch/Endpoints/UpdateByQueryRethrottle.php

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\Exception\RuntimeException;
25:
26:	/**
27:	* NOTE: This file is autogenerated using util/GenerateEndpoints.php
28:	*/
29:	class UpdateByQueryRethrottle extends AbstractEndpoint
30:	{
31:	protected $task_id;
32:
33:	public function getURI(): string
34:	{
35:	if (!isset($this->task_id) \|\| $this->task_id === '') {
36:	throw new RuntimeException('task_id is required for update_by_query_rethrottle');
37:	}
38:	$task_id = $this->task_id;
39:
40:	return '/_update_by_query/' . rawurlencode($task_id) . '/_rethrottle';
41:	}
42:
43:	public function getParamWhitelist(): array
44:	{
45:	return [
46:	'requests_per_second',
47:	'pretty',
48:	'human',
49:	'error_trace',
50:	'source',
51:	'filter_path'
52:	];
53:	}
54:
55:	public function getMethod(): string
56:	{
57:	return 'POST';
58:	}
59:
60:	public function setTaskId($task_id): static
61:	{
62:	if (is_null($task_id)) {
63:	return $this;
64:	}
65:	$this->task_id = $task_id;
66:
67:	return $this;
68:	}
69:	}
70:

Namespaces

Classes