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\Cat;
23:
24: use OpenSearch\Endpoints\AbstractEndpoint;
25:
26: /**
27: * NOTE: This file is autogenerated using util/GenerateEndpoints.php
28: */
29: class Segments extends AbstractEndpoint
30: {
31: public function getURI(): string
32: {
33: $index = $this->index ?? null;
34: if (isset($index)) {
35: return "/_cat/segments/$index";
36: }
37: return "/_cat/segments";
38: }
39:
40: public function getParamWhitelist(): array
41: {
42: return [
43: 'bytes',
44: 'cluster_manager_timeout',
45: 'format',
46: 'h',
47: 'help',
48: 'master_timeout',
49: 's',
50: 'v',
51: 'pretty',
52: 'human',
53: 'error_trace',
54: 'source',
55: 'filter_path'
56: ];
57: }
58:
59: public function getMethod(): string
60: {
61: return 'GET';
62: }
63:
64: protected function getParamDeprecation(): array
65: {
66: return ['master_timeout' => 'cluster_manager_timeout'];
67: }
68: }
69: