File OpenSearch/Endpoints/Cluster/State.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\Cluster;
23:
24:	use OpenSearch\Endpoints\AbstractEndpoint;
25:
26:	/**
27:	* NOTE: This file is autogenerated using util/GenerateEndpoints.php
28:	*/
29:	class State extends AbstractEndpoint
30:	{
31:	protected $metric;
32:
33:	public function getURI(): string
34:	{
35:	$metric = $this->metric ?? null;
36:	$index = $this->index ?? null;
37:	if (isset($metric) && isset($index)) {
38:	return "/_cluster/state/$metric/$index";
39:	}
40:	if (isset($metric)) {
41:	return "/_cluster/state/$metric";
42:	}
43:	return "/_cluster/state";
44:	}
45:
46:	public function getParamWhitelist(): array
47:	{
48:	return [
49:	'allow_no_indices',
50:	'cluster_manager_timeout',
51:	'expand_wildcards',
52:	'flat_settings',
53:	'ignore_unavailable',
54:	'local',
55:	'master_timeout',
56:	'wait_for_metadata_version',
57:	'wait_for_timeout',
58:	'pretty',
59:	'human',
60:	'error_trace',
61:	'source',
62:	'filter_path'
63:	];
64:	}
65:
66:	public function getMethod(): string
67:	{
68:	return 'GET';
69:	}
70:
71:	public function setMetric($metric): static
72:	{
73:	if (isset($metric) !== true) {
74:	return $this;
75:	}
76:	if (is_array($metric) === true) {
77:	$metric = implode(",", $metric);
78:	}
79:	$this->metric = $metric;
80:
81:	return $this;
82:	}
83:
84:	protected function getParamDeprecation(): array
85:	{
86:	return ['master_timeout' => 'cluster_manager_timeout'];
87:	}
88:	}
89:

Namespaces

Classes