| 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\Namespaces; |
| 23: | |
| 24: | use OpenSearch\Namespaces\AbstractNamespace; |
| 25: | |
| 26: | /** |
| 27: | * Class CatNamespace |
| 28: | * |
| 29: | * NOTE: This file is autogenerated using util/GenerateEndpoints.php |
| 30: | */ |
| 31: | class CatNamespace extends AbstractNamespace |
| 32: | { |
| 33: | /** |
| 34: | * Shows information about currently configured aliases to indexes including filter and routing info. |
| 35: | * |
| 36: | * $params['name'] = (array) A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. |
| 37: | * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indexes that are open, closed or both. |
| 38: | * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. |
| 39: | * $params['h'] = (array) Comma-separated list of column names to display. |
| 40: | * $params['help'] = (boolean) Return help information. (Default = false) |
| 41: | * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) |
| 42: | * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. |
| 43: | * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) |
| 44: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 45: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 46: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 47: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 48: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 49: | * |
| 50: | * @param array $params Associative array of parameters |
| 51: | * @return array |
| 52: | */ |
| 53: | public function aliases(array $params = []) |
| 54: | { |
| 55: | $name = $this->extractArgument($params, 'name'); |
| 56: | |
| 57: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\Aliases::class); |
| 58: | $endpoint->setParams($params); |
| 59: | $endpoint->setName($name); |
| 60: | |
| 61: | return $this->performRequest($endpoint); |
| 62: | } |
| 63: | |
| 64: | /** |
| 65: | * Lists all active point-in-time segments. |
| 66: | * |
| 67: | * $params['bytes'] = (enum) The unit in which to display byte values. (Options = b,g,gb,k,kb,m,mb,p,pb,t,tb) |
| 68: | * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. |
| 69: | * $params['h'] = (array) Comma-separated list of column names to display. |
| 70: | * $params['help'] = (boolean) Return help information. (Default = false) |
| 71: | * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. |
| 72: | * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) |
| 73: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 74: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 75: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 76: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 77: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 78: | * |
| 79: | * @param array $params Associative array of parameters |
| 80: | * @return array |
| 81: | */ |
| 82: | public function allPitSegments(array $params = []) |
| 83: | { |
| 84: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\AllPitSegments::class); |
| 85: | $endpoint->setParams($params); |
| 86: | |
| 87: | return $this->performRequest($endpoint); |
| 88: | } |
| 89: | |
| 90: | /** |
| 91: | * Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. |
| 92: | * |
| 93: | * $params['node_id'] = (array) Comma-separated list of node identifiers or names used to limit the returned information. |
| 94: | * $params['bytes'] = (enum) The unit used to display byte values. (Options = b,g,gb,k,kb,m,mb,p,pb,t,tb) |
| 95: | * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. |
| 96: | * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. |
| 97: | * $params['h'] = (array) Comma-separated list of column names to display. |
| 98: | * $params['help'] = (boolean) Return help information. (Default = false) |
| 99: | * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) |
| 100: | * $params['master_timeout'] = (string) Operation timeout for connection to master node. |
| 101: | * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. |
| 102: | * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) |
| 103: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 104: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 105: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 106: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 107: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 108: | * |
| 109: | * @param array $params Associative array of parameters |
| 110: | * @return array |
| 111: | */ |
| 112: | public function allocation(array $params = []) |
| 113: | { |
| 114: | $node_id = $this->extractArgument($params, 'node_id'); |
| 115: | |
| 116: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\Allocation::class); |
| 117: | $endpoint->setParams($params); |
| 118: | $endpoint->setNodeId($node_id); |
| 119: | |
| 120: | return $this->performRequest($endpoint); |
| 121: | } |
| 122: | |
| 123: | /** |
| 124: | * Returns information about the cluster-manager node. |
| 125: | * |
| 126: | * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. |
| 127: | * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. |
| 128: | * $params['h'] = (array) Comma-separated list of column names to display. |
| 129: | * $params['help'] = (boolean) Return help information. (Default = false) |
| 130: | * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) |
| 131: | * $params['master_timeout'] = (string) Operation timeout for connection to master node. |
| 132: | * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. |
| 133: | * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) |
| 134: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 135: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 136: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 137: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 138: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 139: | * |
| 140: | * @param array $params Associative array of parameters |
| 141: | * @return array |
| 142: | */ |
| 143: | public function clusterManager(array $params = []) |
| 144: | { |
| 145: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\ClusterManager::class); |
| 146: | $endpoint->setParams($params); |
| 147: | |
| 148: | return $this->performRequest($endpoint); |
| 149: | } |
| 150: | |
| 151: | /** |
| 152: | * Provides quick access to the document count of the entire cluster, or individual indexes. |
| 153: | * |
| 154: | * $params['index'] = (array) Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. |
| 155: | * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. |
| 156: | * $params['h'] = (array) Comma-separated list of column names to display. |
| 157: | * $params['help'] = (boolean) Return help information. (Default = false) |
| 158: | * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. |
| 159: | * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) |
| 160: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 161: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 162: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 163: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 164: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 165: | * |
| 166: | * @param array $params Associative array of parameters |
| 167: | * @return array |
| 168: | */ |
| 169: | public function count(array $params = []) |
| 170: | { |
| 171: | $index = $this->extractArgument($params, 'index'); |
| 172: | |
| 173: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\Count::class); |
| 174: | $endpoint->setParams($params); |
| 175: | $endpoint->setIndex($index); |
| 176: | |
| 177: | return $this->performRequest($endpoint); |
| 178: | } |
| 179: | |
| 180: | /** |
| 181: | * Shows how much heap memory is currently being used by fielddata on every data node in the cluster. |
| 182: | * |
| 183: | * $params['fields'] = (array) Comma-separated list of fields used to limit returned information. To retrieve all fields, omit this parameter. |
| 184: | * $params['bytes'] = (enum) The unit used to display byte values. (Options = b,g,gb,k,kb,m,mb,p,pb,t,tb) |
| 185: | * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. |
| 186: | * $params['h'] = (array) Comma-separated list of column names to display. |
| 187: | * $params['help'] = (boolean) Return help information. (Default = false) |
| 188: | * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. |
| 189: | * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) |
| 190: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 191: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 192: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 193: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 194: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 195: | * |
| 196: | * @param array $params Associative array of parameters |
| 197: | * @return array |
| 198: | */ |
| 199: | public function fielddata(array $params = []) |
| 200: | { |
| 201: | $fields = $this->extractArgument($params, 'fields'); |
| 202: | |
| 203: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\Fielddata::class); |
| 204: | $endpoint->setParams($params); |
| 205: | $endpoint->setFields($fields); |
| 206: | |
| 207: | return $this->performRequest($endpoint); |
| 208: | } |
| 209: | |
| 210: | /** |
| 211: | * Returns a concise representation of the cluster health. |
| 212: | * |
| 213: | * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. |
| 214: | * $params['h'] = (array) Comma-separated list of column names to display. |
| 215: | * $params['help'] = (boolean) Return help information. (Default = false) |
| 216: | * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. |
| 217: | * $params['time'] = (enum) The unit used to display time values. (Options = d,h,m,micros,ms,nanos,s) |
| 218: | * $params['ts'] = (boolean) If true, returns `HH:MM:SS` and Unix epoch timestamps. (Default = true) |
| 219: | * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) |
| 220: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 221: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 222: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 223: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 224: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 225: | * |
| 226: | * @param array $params Associative array of parameters |
| 227: | * @return array |
| 228: | */ |
| 229: | public function health(array $params = []) |
| 230: | { |
| 231: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\Health::class); |
| 232: | $endpoint->setParams($params); |
| 233: | |
| 234: | return $this->performRequest($endpoint); |
| 235: | } |
| 236: | |
| 237: | /** |
| 238: | * Returns help for the Cat APIs. |
| 239: | * |
| 240: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 241: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 242: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 243: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 244: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 245: | * |
| 246: | * @param array $params Associative array of parameters |
| 247: | * @return array |
| 248: | */ |
| 249: | public function help(array $params = []) |
| 250: | { |
| 251: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\Help::class); |
| 252: | $endpoint->setParams($params); |
| 253: | |
| 254: | return $this->performRequest($endpoint); |
| 255: | } |
| 256: | |
| 257: | /** |
| 258: | * Returns information about indexes: number of primaries and replicas, document counts, disk size, ... |
| 259: | * |
| 260: | * $params['index'] = (array) Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. |
| 261: | * $params['bytes'] = (enum) The unit used to display byte values. (Options = b,g,gb,k,kb,m,mb,p,pb,t,tb) |
| 262: | * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. |
| 263: | * $params['expand_wildcards'] = (any) The type of index that wildcard patterns can match. |
| 264: | * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. |
| 265: | * $params['h'] = (array) Comma-separated list of column names to display. |
| 266: | * $params['health'] = (enum) The health status used to limit returned indexes. By default, the response includes indexes of any health status. (Options = green,red,yellow) |
| 267: | * $params['help'] = (boolean) Return help information. (Default = false) |
| 268: | * $params['include_unloaded_segments'] = (boolean) If true, the response includes information from segments that are not loaded into memory. (Default = false) |
| 269: | * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) |
| 270: | * $params['master_timeout'] = (string) Operation timeout for connection to master node. |
| 271: | * $params['pri'] = (boolean) If true, the response only includes information from primary shards. (Default = false) |
| 272: | * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. |
| 273: | * $params['time'] = (enum) The unit used to display time values. (Options = d,h,m,micros,ms,nanos,s) |
| 274: | * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) |
| 275: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 276: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 277: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 278: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 279: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 280: | * |
| 281: | * @param array $params Associative array of parameters |
| 282: | * @return array |
| 283: | */ |
| 284: | public function indices(array $params = []) |
| 285: | { |
| 286: | $index = $this->extractArgument($params, 'index'); |
| 287: | |
| 288: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\Indices::class); |
| 289: | $endpoint->setParams($params); |
| 290: | $endpoint->setIndex($index); |
| 291: | |
| 292: | return $this->performRequest($endpoint); |
| 293: | } |
| 294: | |
| 295: | /** |
| 296: | * Returns information about the cluster-manager node. |
| 297: | * |
| 298: | * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. |
| 299: | * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. |
| 300: | * $params['h'] = (array) Comma-separated list of column names to display. |
| 301: | * $params['help'] = (boolean) Return help information. (Default = false) |
| 302: | * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) |
| 303: | * $params['master_timeout'] = (string) Operation timeout for connection to master node. |
| 304: | * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. |
| 305: | * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) |
| 306: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 307: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 308: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 309: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 310: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 311: | * |
| 312: | * @param array $params Associative array of parameters |
| 313: | * @return array |
| 314: | */ |
| 315: | public function master(array $params = []) |
| 316: | { |
| 317: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\Master::class); |
| 318: | $endpoint->setParams($params); |
| 319: | |
| 320: | return $this->performRequest($endpoint); |
| 321: | } |
| 322: | |
| 323: | /** |
| 324: | * Returns information about custom node attributes. |
| 325: | * |
| 326: | * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. |
| 327: | * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. |
| 328: | * $params['h'] = (array) Comma-separated list of column names to display. |
| 329: | * $params['help'] = (boolean) Return help information. (Default = false) |
| 330: | * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) |
| 331: | * $params['master_timeout'] = (string) Operation timeout for connection to master node. |
| 332: | * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. |
| 333: | * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) |
| 334: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 335: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 336: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 337: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 338: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 339: | * |
| 340: | * @param array $params Associative array of parameters |
| 341: | * @return array |
| 342: | */ |
| 343: | public function nodeattrs(array $params = []) |
| 344: | { |
| 345: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\NodeAttrs::class); |
| 346: | $endpoint->setParams($params); |
| 347: | |
| 348: | return $this->performRequest($endpoint); |
| 349: | } |
| 350: | |
| 351: | /** |
| 352: | * Returns basic statistics about performance of cluster nodes. |
| 353: | * |
| 354: | * $params['bytes'] = (enum) The unit used to display byte values. (Options = b,g,gb,k,kb,m,mb,p,pb,t,tb) |
| 355: | * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. |
| 356: | * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. |
| 357: | * $params['full_id'] = (any) If `true`, return the full node ID. If `false`, return the shortened node ID. (Default = ) |
| 358: | * $params['h'] = (array) Comma-separated list of column names to display. |
| 359: | * $params['help'] = (boolean) Return help information. (Default = false) |
| 360: | * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) |
| 361: | * $params['master_timeout'] = (string) Operation timeout for connection to master node. |
| 362: | * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. |
| 363: | * $params['time'] = (enum) The unit in which to display time values. (Options = d,h,m,micros,ms,nanos,s) |
| 364: | * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) |
| 365: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 366: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 367: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 368: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 369: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 370: | * |
| 371: | * @param array $params Associative array of parameters |
| 372: | * @return array |
| 373: | */ |
| 374: | public function nodes(array $params = []) |
| 375: | { |
| 376: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\Nodes::class); |
| 377: | $endpoint->setParams($params); |
| 378: | |
| 379: | return $this->performRequest($endpoint); |
| 380: | } |
| 381: | |
| 382: | /** |
| 383: | * Returns a concise representation of the cluster pending tasks. |
| 384: | * |
| 385: | * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. |
| 386: | * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. |
| 387: | * $params['h'] = (array) Comma-separated list of column names to display. |
| 388: | * $params['help'] = (boolean) Return help information. (Default = false) |
| 389: | * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) |
| 390: | * $params['master_timeout'] = (string) Operation timeout for connection to master node. |
| 391: | * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. |
| 392: | * $params['time'] = (enum) The unit in which to display time values. (Options = d,h,m,micros,ms,nanos,s) |
| 393: | * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) |
| 394: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 395: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 396: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 397: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 398: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 399: | * |
| 400: | * @param array $params Associative array of parameters |
| 401: | * @return array |
| 402: | */ |
| 403: | public function pendingTasks(array $params = []) |
| 404: | { |
| 405: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\PendingTasks::class); |
| 406: | $endpoint->setParams($params); |
| 407: | |
| 408: | return $this->performRequest($endpoint); |
| 409: | } |
| 410: | |
| 411: | /** |
| 412: | * List segments for one or several PITs. |
| 413: | * |
| 414: | * $params['bytes'] = (enum) The unit in which to display byte values. (Options = b,g,gb,k,kb,m,mb,p,pb,t,tb) |
| 415: | * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. |
| 416: | * $params['h'] = (array) Comma-separated list of column names to display. |
| 417: | * $params['help'] = (boolean) Return help information. (Default = false) |
| 418: | * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. |
| 419: | * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) |
| 420: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 421: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 422: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 423: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 424: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 425: | * |
| 426: | * @param array $params Associative array of parameters |
| 427: | * @return array |
| 428: | */ |
| 429: | public function pitSegments(array $params = []) |
| 430: | { |
| 431: | $body = $this->extractArgument($params, 'body'); |
| 432: | |
| 433: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\PitSegments::class); |
| 434: | $endpoint->setParams($params); |
| 435: | $endpoint->setBody($body); |
| 436: | |
| 437: | return $this->performRequest($endpoint); |
| 438: | } |
| 439: | |
| 440: | /** |
| 441: | * Returns information about installed plugins across nodes node. |
| 442: | * |
| 443: | * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. |
| 444: | * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. |
| 445: | * $params['h'] = (array) Comma-separated list of column names to display. |
| 446: | * $params['help'] = (boolean) Return help information. (Default = false) |
| 447: | * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) |
| 448: | * $params['master_timeout'] = (string) Operation timeout for connection to master node. |
| 449: | * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. |
| 450: | * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) |
| 451: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 452: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 453: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 454: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 455: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 456: | * |
| 457: | * @param array $params Associative array of parameters |
| 458: | * @return array |
| 459: | */ |
| 460: | public function plugins(array $params = []) |
| 461: | { |
| 462: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\Plugins::class); |
| 463: | $endpoint->setParams($params); |
| 464: | |
| 465: | return $this->performRequest($endpoint); |
| 466: | } |
| 467: | |
| 468: | /** |
| 469: | * Returns information about index shard recoveries, both on-going completed. |
| 470: | * |
| 471: | * $params['index'] = (array) A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. |
| 472: | * $params['active_only'] = (boolean) If `true`, the response only includes ongoing shard recoveries. (Default = false) |
| 473: | * $params['bytes'] = (enum) The unit used to display byte values. (Options = b,g,gb,k,kb,m,mb,p,pb,t,tb) |
| 474: | * $params['detailed'] = (boolean) If `true`, the response includes detailed information about shard recoveries. (Default = false) |
| 475: | * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. |
| 476: | * $params['h'] = (array) Comma-separated list of column names to display. |
| 477: | * $params['help'] = (boolean) Return help information. (Default = false) |
| 478: | * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. |
| 479: | * $params['time'] = (enum) The unit in which to display time values. (Options = d,h,m,micros,ms,nanos,s) |
| 480: | * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) |
| 481: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 482: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 483: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 484: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 485: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 486: | * |
| 487: | * @param array $params Associative array of parameters |
| 488: | * @return array |
| 489: | */ |
| 490: | public function recovery(array $params = []) |
| 491: | { |
| 492: | $index = $this->extractArgument($params, 'index'); |
| 493: | |
| 494: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\Recovery::class); |
| 495: | $endpoint->setParams($params); |
| 496: | $endpoint->setIndex($index); |
| 497: | |
| 498: | return $this->performRequest($endpoint); |
| 499: | } |
| 500: | |
| 501: | /** |
| 502: | * Returns information about snapshot repositories registered in the cluster. |
| 503: | * |
| 504: | * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. |
| 505: | * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. |
| 506: | * $params['h'] = (array) Comma-separated list of column names to display. |
| 507: | * $params['help'] = (boolean) Return help information. (Default = false) |
| 508: | * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) |
| 509: | * $params['master_timeout'] = (string) Operation timeout for connection to master node. |
| 510: | * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. |
| 511: | * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) |
| 512: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 513: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 514: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 515: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 516: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 517: | * |
| 518: | * @param array $params Associative array of parameters |
| 519: | * @return array |
| 520: | */ |
| 521: | public function repositories(array $params = []) |
| 522: | { |
| 523: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\Repositories::class); |
| 524: | $endpoint->setParams($params); |
| 525: | |
| 526: | return $this->performRequest($endpoint); |
| 527: | } |
| 528: | |
| 529: | /** |
| 530: | * Returns information about both on-going and latest completed Segment Replication events. |
| 531: | * |
| 532: | * $params['index'] = (array) Comma-separated list or wildcard expression of index names to limit the returned information. |
| 533: | * $params['active_only'] = (boolean) If `true`, the response only includes ongoing segment replication events. (Default = false) |
| 534: | * $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). |
| 535: | * $params['bytes'] = (enum) The unit in which to display byte values. (Options = b,g,gb,k,kb,m,mb,p,pb,t,tb) |
| 536: | * $params['completed_only'] = (boolean) If `true`, the response only includes latest completed segment replication events. (Default = false) |
| 537: | * $params['detailed'] = (boolean) If `true`, the response includes detailed information about segment replications. (Default = false) |
| 538: | * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indexes that are open, closed or both. |
| 539: | * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. |
| 540: | * $params['h'] = (array) Comma-separated list of column names to display. |
| 541: | * $params['help'] = (boolean) Return help information. (Default = false) |
| 542: | * $params['ignore_throttled'] = (boolean) Whether specified concrete, expanded or aliased indexes should be ignored when throttled. |
| 543: | * $params['ignore_unavailable'] = (boolean) Whether specified concrete indexes should be ignored when unavailable (missing or closed). |
| 544: | * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. |
| 545: | * $params['shards'] = (array) Comma-separated list of shards to display. |
| 546: | * $params['time'] = (enum) The unit in which to display time values. (Options = d,h,m,micros,ms,nanos,s) |
| 547: | * $params['timeout'] = (string) Operation timeout. |
| 548: | * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) |
| 549: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 550: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 551: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 552: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 553: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 554: | * |
| 555: | * @param array $params Associative array of parameters |
| 556: | * @return array |
| 557: | */ |
| 558: | public function segmentReplication(array $params = []) |
| 559: | { |
| 560: | $index = $this->extractArgument($params, 'index'); |
| 561: | |
| 562: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\SegmentReplication::class); |
| 563: | $endpoint->setParams($params); |
| 564: | $endpoint->setIndex($index); |
| 565: | |
| 566: | return $this->performRequest($endpoint); |
| 567: | } |
| 568: | |
| 569: | /** |
| 570: | * Provides low-level information about the segments in the shards of an index. |
| 571: | * |
| 572: | * $params['index'] = (array) A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. |
| 573: | * $params['bytes'] = (enum) The unit used to display byte values. (Options = b,g,gb,k,kb,m,mb,p,pb,t,tb) |
| 574: | * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. |
| 575: | * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. |
| 576: | * $params['h'] = (array) Comma-separated list of column names to display. |
| 577: | * $params['help'] = (boolean) Return help information. (Default = false) |
| 578: | * $params['master_timeout'] = (string) Operation timeout for connection to master node. |
| 579: | * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. |
| 580: | * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) |
| 581: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 582: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 583: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 584: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 585: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 586: | * |
| 587: | * @param array $params Associative array of parameters |
| 588: | * @return array |
| 589: | */ |
| 590: | public function segments(array $params = []) |
| 591: | { |
| 592: | $index = $this->extractArgument($params, 'index'); |
| 593: | |
| 594: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\Segments::class); |
| 595: | $endpoint->setParams($params); |
| 596: | $endpoint->setIndex($index); |
| 597: | |
| 598: | return $this->performRequest($endpoint); |
| 599: | } |
| 600: | |
| 601: | /** |
| 602: | * Provides a detailed view of shard allocation on nodes. |
| 603: | * |
| 604: | * $params['index'] = (array) A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. |
| 605: | * $params['bytes'] = (enum) The unit used to display byte values. (Options = b,g,gb,k,kb,m,mb,p,pb,t,tb) |
| 606: | * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. |
| 607: | * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. |
| 608: | * $params['h'] = (array) Comma-separated list of column names to display. |
| 609: | * $params['help'] = (boolean) Return help information. (Default = false) |
| 610: | * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) |
| 611: | * $params['master_timeout'] = (string) Operation timeout for connection to master node. |
| 612: | * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. |
| 613: | * $params['time'] = (enum) The unit in which to display time values. (Options = d,h,m,micros,ms,nanos,s) |
| 614: | * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) |
| 615: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 616: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 617: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 618: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 619: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 620: | * |
| 621: | * @param array $params Associative array of parameters |
| 622: | * @return array |
| 623: | */ |
| 624: | public function shards(array $params = []) |
| 625: | { |
| 626: | $index = $this->extractArgument($params, 'index'); |
| 627: | |
| 628: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\Shards::class); |
| 629: | $endpoint->setParams($params); |
| 630: | $endpoint->setIndex($index); |
| 631: | |
| 632: | return $this->performRequest($endpoint); |
| 633: | } |
| 634: | |
| 635: | /** |
| 636: | * Returns all snapshots in a specific repository. |
| 637: | * |
| 638: | * $params['repository'] = (array) A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. If any repository fails during the request, OpenSearch returns an error. |
| 639: | * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. |
| 640: | * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. |
| 641: | * $params['h'] = (array) Comma-separated list of column names to display. |
| 642: | * $params['help'] = (boolean) Return help information. (Default = false) |
| 643: | * $params['ignore_unavailable'] = (boolean) If `true`, the response does not include information from unavailable snapshots. (Default = false) |
| 644: | * $params['master_timeout'] = (string) Operation timeout for connection to master node. |
| 645: | * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. |
| 646: | * $params['time'] = (enum) The unit in which to display time values. (Options = d,h,m,micros,ms,nanos,s) |
| 647: | * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) |
| 648: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 649: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 650: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 651: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 652: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 653: | * |
| 654: | * @param array $params Associative array of parameters |
| 655: | * @return array |
| 656: | */ |
| 657: | public function snapshots(array $params = []) |
| 658: | { |
| 659: | $repository = $this->extractArgument($params, 'repository'); |
| 660: | |
| 661: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\Snapshots::class); |
| 662: | $endpoint->setParams($params); |
| 663: | $endpoint->setRepository($repository); |
| 664: | |
| 665: | return $this->performRequest($endpoint); |
| 666: | } |
| 667: | |
| 668: | /** |
| 669: | * Returns information about the tasks currently executing on one or more nodes in the cluster. |
| 670: | * |
| 671: | * $params['actions'] = (array) The task action names, which are used to limit the response. |
| 672: | * $params['detailed'] = (boolean) If `true`, the response includes detailed information about shard recoveries. (Default = false) |
| 673: | * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. |
| 674: | * $params['h'] = (array) Comma-separated list of column names to display. |
| 675: | * $params['help'] = (boolean) Return help information. (Default = false) |
| 676: | * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. |
| 677: | * $params['time'] = (enum) The unit in which to display time values. (Options = d,h,m,micros,ms,nanos,s) |
| 678: | * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) |
| 679: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 680: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 681: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 682: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 683: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 684: | * $params['node_id'] = (array) Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. |
| 685: | * $params['parent_task'] = (string) The parent task identifier, which is used to limit the response. |
| 686: | * |
| 687: | * @param array $params Associative array of parameters |
| 688: | * @return array |
| 689: | */ |
| 690: | public function tasks(array $params = []) |
| 691: | { |
| 692: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\Tasks::class); |
| 693: | $endpoint->setParams($params); |
| 694: | |
| 695: | return $this->performRequest($endpoint); |
| 696: | } |
| 697: | |
| 698: | /** |
| 699: | * Returns information about existing templates. |
| 700: | * |
| 701: | * $params['name'] = (string) The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned. |
| 702: | * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. |
| 703: | * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. |
| 704: | * $params['h'] = (array) Comma-separated list of column names to display. |
| 705: | * $params['help'] = (boolean) Return help information. (Default = false) |
| 706: | * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) |
| 707: | * $params['master_timeout'] = (string) Operation timeout for connection to master node. |
| 708: | * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. |
| 709: | * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) |
| 710: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 711: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 712: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 713: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 714: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 715: | * |
| 716: | * @param array $params Associative array of parameters |
| 717: | * @return array |
| 718: | */ |
| 719: | public function templates(array $params = []) |
| 720: | { |
| 721: | $name = $this->extractArgument($params, 'name'); |
| 722: | |
| 723: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\Templates::class); |
| 724: | $endpoint->setParams($params); |
| 725: | $endpoint->setName($name); |
| 726: | |
| 727: | return $this->performRequest($endpoint); |
| 728: | } |
| 729: | |
| 730: | /** |
| 731: | * Returns cluster-wide thread pool statistics per node.By default the active, queue and rejected statistics are returned for all thread pools. |
| 732: | * |
| 733: | * $params['thread_pool_patterns'] = (array) A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions. |
| 734: | * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. |
| 735: | * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. |
| 736: | * $params['h'] = (array) Comma-separated list of column names to display. |
| 737: | * $params['help'] = (boolean) Return help information. (Default = false) |
| 738: | * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) |
| 739: | * $params['master_timeout'] = (string) Operation timeout for connection to master node. |
| 740: | * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. |
| 741: | * $params['size'] = (integer) The multiplier in which to display values. |
| 742: | * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) |
| 743: | * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) |
| 744: | * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) |
| 745: | * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) |
| 746: | * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. |
| 747: | * $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". |
| 748: | * |
| 749: | * @param array $params Associative array of parameters |
| 750: | * @return array |
| 751: | */ |
| 752: | public function threadPool(array $params = []) |
| 753: | { |
| 754: | $thread_pool_patterns = $this->extractArgument($params, 'thread_pool_patterns'); |
| 755: | |
| 756: | $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Cat\ThreadPool::class); |
| 757: | $endpoint->setParams($params); |
| 758: | $endpoint->setThreadPoolPatterns($thread_pool_patterns); |
| 759: | |
| 760: | return $this->performRequest($endpoint); |
| 761: | } |
| 762: | |
| 763: | } |
| 764: |