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\Indices;
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 Get extends AbstractEndpoint
31: {
32: public function getURI(): string
33: {
34: $index = $this->index ?? null;
35: if (isset($index)) {
36: return "/$index";
37: }
38: throw new RuntimeException('Missing parameter for the endpoint indices.get');
39: }
40:
41: public function getParamWhitelist(): array
42: {
43: return [
44: 'allow_no_indices',
45: 'cluster_manager_timeout',
46: 'expand_wildcards',
47: 'flat_settings',
48: 'ignore_unavailable',
49: 'include_defaults',
50: 'local',
51: 'master_timeout',
52: 'pretty',
53: 'human',
54: 'error_trace',
55: 'source',
56: 'filter_path'
57: ];
58: }
59:
60: public function getMethod(): string
61: {
62: return 'GET';
63: }
64:
65: protected function getParamDeprecation(): array
66: {
67: return ['master_timeout' => 'cluster_manager_timeout'];
68: }
69: }
70: