From 33dd62265b36f9481d0fa3c9d605e1adf450c785 Mon Sep 17 00:00:00 2001 From: dblock Date: Fri, 15 Nov 2024 03:41:43 +0000 Subject: [PATCH] Updated opensearch-php to reflect the latest OpenSearch API spec (2024-11-15) Signed-off-by: GitHub --- CHANGELOG.md | 1 + src/OpenSearch/Client.php | 68 ++++----- src/OpenSearch/Namespaces/CatNamespace.php | 28 ++-- .../Namespaces/ClusterNamespace.php | 16 +- .../Namespaces/DanglingIndicesNamespace.php | 2 +- .../Namespaces/IndicesNamespace.php | 138 +++++++++--------- src/OpenSearch/Namespaces/IsmNamespace.php | 12 +- src/OpenSearch/Namespaces/KnnNamespace.php | 10 +- src/OpenSearch/Namespaces/NodesNamespace.php | 2 +- .../Namespaces/SecurityNamespace.php | 2 +- .../Namespaces/SnapshotNamespace.php | 2 +- src/OpenSearch/Namespaces/WlmNamespace.php | 12 +- 12 files changed, 147 insertions(+), 146 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6c6aedc2..52b18574 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) ### Fixed - Fixed PHP 8.4 deprecations ### Updated APIs +- Updated opensearch-php APIs to reflect [opensearch-api-specification@398481e](https://github.com/opensearch-project/opensearch-api-specification/commit/398481e5bd1cc590d947c35379c47096f2114f00) - Updated opensearch-php APIs to reflect [opensearch-api-specification@6bb1fed](https://github.com/opensearch-project/opensearch-api-specification/commit/6bb1fed0a2c7cf094a5ecfdb01f0306a4b9f8eba) - Updated opensearch-php APIs to reflect [opensearch-api-specification@07e329e](https://github.com/opensearch-project/opensearch-api-specification/commit/07e329e8d01fd0576de6a0a3c35412fd5a9163db) - Updated opensearch-php APIs to reflect [opensearch-api-specification@1db1840](https://github.com/opensearch-project/opensearch-api-specification/commit/1db184063a463c5180a2cc824b1efc1aeebfd5eb) diff --git a/src/OpenSearch/Client.php b/src/OpenSearch/Client.php index 683e99bd..05299e98 100644 --- a/src/OpenSearch/Client.php +++ b/src/OpenSearch/Client.php @@ -372,7 +372,7 @@ public function bulkStream(array $params = []) * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) * $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. * $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 "-". - * $params['body'] = (array) Comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter + * $params['body'] = (array) Comma-separated list of scroll IDs to clear if none was specified using the `scroll_id` parameter * * @param array $params Associative array of parameters * @return array @@ -393,14 +393,14 @@ public function clearScroll(array $params = []) /** * Returns number of documents matching a query. * - * $params['index'] = (array) Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*` or `_all`. - * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.This behavior applies even if the request targets other open indices. + * $params['index'] = (array) Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams and indexes, omit this parameter or use `*` or `_all`. + * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes. * $params['analyze_wildcard'] = (boolean) If `true`, wildcard and prefix queries are analyzed.This parameter can only be used when the `q` query string parameter is specified. (Default = false) * $params['analyzer'] = (string) Analyzer to use for the query string.This parameter can only be used when the `q` query string parameter is specified. * $params['default_operator'] = (enum) The default operator for query string query: `AND` or `OR`.This parameter can only be used when the `q` query string parameter is specified. (Options = and,or) * $params['df'] = (string) Field to use as default where no field prefix is given in the query string.This parameter can only be used when the `q` query string parameter is specified. * $params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as `open,hidden`. - * $params['ignore_throttled'] = (boolean) If `true`, concrete, expanded or aliased indices are ignored when frozen. + * $params['ignore_throttled'] = (boolean) If `true`, concrete, expanded or aliased indexes are ignored when frozen. * $params['ignore_unavailable'] = (boolean) If `false`, the request returns an error if it targets a missing or closed index. * $params['lenient'] = (boolean) If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. * $params['min_score'] = (number) Sets the minimum `_score` value that documents must have to be included in the result. @@ -434,9 +434,9 @@ public function count(array $params = []) /** * Creates point in time context. * - * $params['index'] = (array) Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. (Required) + * $params['index'] = (array) Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. (Required) * $params['allow_partial_pit_creation'] = (boolean) Allow if point in time can be created with partial failures. - * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indices that are open, closed or both. + * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indexes that are open, closed or both. * $params['keep_alive'] = (string) Specify the keep alive for point in time. * $params['preference'] = (string) Specify the node or shard the operation should be performed on. (Default = random) * $params['routing'] = (any) Comma-separated list of specific routing values. @@ -518,11 +518,11 @@ public function deleteAllPits(array $params = []) /** * Deletes documents matching the provided query. * - * $params['index'] = (array) Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this parameter or use `*` or `_all`. (Required) + * $params['index'] = (array) Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams or indexes, omit this parameter or use `*` or `_all`. (Required) * $params['_source'] = (array) True or false to return the _source field or not, or a list of fields to return. * $params['_source_excludes'] = (array) List of fields to exclude from the returned _source field. * $params['_source_includes'] = (array) List of fields to extract and return from the _source field. - * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.This behavior applies even if the request targets other open indices.For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes.For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. * $params['analyze_wildcard'] = (boolean) If `true`, wildcard and prefix queries are analyzed. (Default = false) * $params['analyzer'] = (string) Analyzer to use for the query string. * $params['conflicts'] = (enum) What to do if delete by query hits version conflicts: `abort` or `proceed`. (Options = abort,proceed) @@ -547,7 +547,7 @@ public function deleteAllPits(array $params = []) * $params['slices'] = (any) The number of slices this task should be divided into. * $params['sort'] = (array) A comma-separated list of : pairs. * $params['stats'] = (array) Specific `tag` of the request for logging and statistical purposes. - * $params['terminate_after'] = (integer) Maximum number of documents to collect for each shard.If a query reaches this limit, OpenSearch terminates the query early.OpenSearch collects documents before sorting.Use with caution.OpenSearch applies this parameter to each shard handling the request.When possible, let OpenSearch perform early termination automatically.Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + * $params['terminate_after'] = (integer) Maximum number of documents to collect for each shard.If a query reaches this limit, OpenSearch terminates the query early.OpenSearch collects documents before sorting.Use with caution.OpenSearch applies this parameter to each shard handling the request.When possible, let OpenSearch perform early termination automatically.Avoid specifying this parameter for requests that target data streams with backing indexes across multiple data tiers. * $params['timeout'] = (string) Period each deletion request waits for active shards. * $params['version'] = (boolean) If `true`, returns the document version as part of a hit. * $params['wait_for_active_shards'] = (any) The number of shard copies that must be active before proceeding with the operation.Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). @@ -655,7 +655,7 @@ public function deleteScript(array $params = []) * Returns information about whether a document exists in an index. * * $params['id'] = (string) Identifier of the document. (Required) - * $params['index'] = (string) Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). (Required) + * $params['index'] = (string) Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). (Required) * $params['_source'] = (any) `true` or `false` to return the `_source` field or not, or a list of fields to return. * $params['_source_excludes'] = (any) A comma-separated list of source fields to exclude in the response. * $params['_source_includes'] = (any) A comma-separated list of source fields to include in the response. @@ -695,7 +695,7 @@ public function exists(array $params = []): bool * Returns information about whether a document source exists in an index. * * $params['id'] = (string) Identifier of the document. (Required) - * $params['index'] = (string) Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). (Required) + * $params['index'] = (string) Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). (Required) * $params['_source'] = (any) `true` or `false` to return the `_source` field or not, or a list of fields to return. * $params['_source_excludes'] = (any) A comma-separated list of source fields to exclude in the response. * $params['_source_includes'] = (any) A comma-separated list of source fields to include in the response. @@ -773,13 +773,13 @@ public function explain(array $params = []) return $this->performRequest($endpoint); } /** - * Returns the information about the capabilities of fields among multiple indices. + * Returns the information about the capabilities of fields among multiple indexes. * - * $params['index'] = (array) Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all. - * $params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, index alias,or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a requesttargeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar. + * $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. + * $params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, index alias,or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a requesttargeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar. * $params['expand_wildcards'] = (any) Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. * $params['fields'] = (any) Comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported. - * $params['ignore_unavailable'] = (boolean) If `true`, missing or closed indices are not included in the response. + * $params['ignore_unavailable'] = (boolean) If `true`, missing or closed indexes are not included in the response. * $params['include_unmapped'] = (boolean) If true, unmapped fields are included in the response. (Default = false) * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) @@ -1062,7 +1062,7 @@ public function mget(array $params = []) /** * Allows to execute several search operations in one request. * - * $params['index'] = (array) Comma-separated list of data streams, indices, and index aliases to search. + * $params['index'] = (array) Comma-separated list of data streams, indexes, and index aliases to search. * $params['ccs_minimize_roundtrips'] = (boolean) If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. (Default = true) * $params['max_concurrent_searches'] = (integer) Maximum number of concurrent searches the multi search API can execute. * $params['max_concurrent_shard_requests'] = (integer) Maximum number of concurrent shard requests that each sub-search request executes per node. (Default = 5) @@ -1096,7 +1096,7 @@ public function msearch(array $params = []) /** * Allows to execute several search template operations in one request. * - * $params['index'] = (array) Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*`. + * $params['index'] = (array) Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams and indexes, omit this parameter or use `*`. * $params['ccs_minimize_roundtrips'] = (boolean) If `true`, network round-trips are minimized for cross-cluster search requests. (Default = true) * $params['max_concurrent_searches'] = (integer) Maximum number of concurrent searches the API can run. * $params['rest_total_hits_as_int'] = (boolean) If `true`, the response returns `hits.total` as an integer.If `false`, it returns `hits.total` as an object. (Default = false) @@ -1223,10 +1223,10 @@ public function putScript(array $params = []) /** * Allows to evaluate the quality of ranked search results over a set of typical search queries. * - * $params['index'] = (array) Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard (`*`) expressions are supported. To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`. - * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. - * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indices that are open, closed or both. - * $params['ignore_unavailable'] = (boolean) If `true`, missing or closed indices are not included in the response. + * $params['index'] = (array) Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard (`*`) expressions are supported. To target all data streams and indexes in a cluster, omit this parameter or use `_all` or `*`. + * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indexes that are open, closed or both. + * $params['ignore_unavailable'] = (boolean) If `true`, missing or closed indexes are not included in the response. * $params['search_type'] = (enum) Search operation type (Options = dfs_query_then_fetch,query_then_fetch) * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) @@ -1391,11 +1391,11 @@ public function scroll(array $params = []) /** * Returns results matching a query. * - * $params['index'] = (array) Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*` or `_all`. + * $params['index'] = (array) Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams and indexes, omit this parameter or use `*` or `_all`. * $params['_source'] = (any) Indicates which source fields are returned for matching documents.These fields are returned in the `hits._source` property of the search response.Valid values are:`true` to return the entire document source;`false` to not return the document source;`` to return the source fields that are specified as a comma-separated list (supports wildcard (`*`) patterns). * $params['_source_excludes'] = (any) A comma-separated list of source fields to exclude from the response.You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.If the `_source` parameter is `false`, this parameter is ignored. * $params['_source_includes'] = (any) A comma-separated list of source fields to include in the response.If this parameter is specified, only these source fields are returned.You can exclude fields from this subset using the `_source_excludes` query parameter.If the `_source` parameter is `false`, this parameter is ignored. - * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.This behavior applies even if the request targets other open indices.For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes.For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. * $params['allow_partial_search_results'] = (boolean) If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. (Default = true) * $params['analyze_wildcard'] = (boolean) If true, wildcard and prefix queries are analyzed.This parameter can only be used when the q query string parameter is specified. (Default = false) * $params['analyzer'] = (string) Analyzer to use for the query string.This parameter can only be used when the q query string parameter is specified. @@ -1408,7 +1408,7 @@ public function scroll(array $params = []) * $params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as `open,hidden`. * $params['explain'] = (boolean) If `true`, returns detailed information about score computation as part of a hit. * $params['from'] = (integer) Starting document offset.Needs to be non-negative.By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.To page through more hits, use the `search_after` parameter. (Default = 0) - * $params['ignore_throttled'] = (boolean) If `true`, concrete, expanded or aliased indices will be ignored when frozen. + * $params['ignore_throttled'] = (boolean) If `true`, concrete, expanded or aliased indexes will be ignored when frozen. * $params['ignore_unavailable'] = (boolean) If `false`, the request returns an error if it targets a missing or closed index. * $params['include_named_queries_score'] = (boolean) Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) (Default = false) * $params['lenient'] = (boolean) If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.This parameter can only be used when the `q` query string parameter is specified. @@ -1432,7 +1432,7 @@ public function scroll(array $params = []) * $params['suggest_mode'] = (enum) Specifies the suggest mode.This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. (Options = always,missing,popular) * $params['suggest_size'] = (integer) Number of suggestions to return.This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. * $params['suggest_text'] = (string) The source text for which the suggestions should be returned.This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. - * $params['terminate_after'] = (integer) Maximum number of documents to collect for each shard.If a query reaches this limit, OpenSearch terminates the query early.OpenSearch collects documents before sorting.Use with caution.OpenSearch applies this parameter to each shard handling the request.When possible, let OpenSearch perform early termination automatically.Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.If set to `0` (default), the query does not terminate early. + * $params['terminate_after'] = (integer) Maximum number of documents to collect for each shard.If a query reaches this limit, OpenSearch terminates the query early.OpenSearch collects documents before sorting.Use with caution.OpenSearch applies this parameter to each shard handling the request.When possible, let OpenSearch perform early termination automatically.Avoid specifying this parameter for requests that target data streams with backing indexes across multiple data tiers.If set to `0` (default), the query does not terminate early. * $params['timeout'] = (string) Specifies the period of time to wait for a response from each shard.If no response is received before the timeout expires, the request fails and returns an error. * $params['track_scores'] = (boolean) If `true`, calculate and return document scores, even if the scores are not used for sorting. * $params['track_total_hits'] = (any) Number of hits matching the query to count accurately.If `true`, the exact number of hits is returned at the cost of some performance.If `false`, the response does not include the total number of hits matching the query. @@ -1462,10 +1462,10 @@ public function search(array $params = []) return $this->performRequest($endpoint); } /** - * Returns information about the indices and shards that a search request would be executed against. + * Returns information about the indexes and shards that a search request would be executed against. * - * $params['index'] = (array) Returns the indices and shards that a search request would be executed against. - * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.This behavior applies even if the request targets other open indices.For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + * $params['index'] = (array) Returns the indexes and shards that a search request would be executed against. + * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes.For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. * $params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as `open,hidden`.Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * $params['ignore_unavailable'] = (boolean) If `false`, the request returns an error if it targets a missing or closed index. * $params['local'] = (boolean) If `true`, the request retrieves information from the local node only. (Default = false) @@ -1494,12 +1494,12 @@ public function searchShards(array $params = []) /** * Allows to use the Mustache language to pre-render a search definition. * - * $params['index'] = (array) Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*). - * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.This behavior applies even if the request targets other open indices.For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + * $params['index'] = (array) Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (*). + * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes.For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. * $params['ccs_minimize_roundtrips'] = (boolean) If `true`, network round-trips are minimized for cross-cluster search requests. (Default = true) * $params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as `open,hidden`.Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * $params['explain'] = (boolean) If `true`, the response includes additional details about score computation as part of a hit. - * $params['ignore_throttled'] = (boolean) If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. + * $params['ignore_throttled'] = (boolean) If `true`, specified concrete, expanded, or aliased indexes are not included in the response when throttled. * $params['ignore_unavailable'] = (boolean) If `false`, the request returns an error if it targets a missing or closed index. * $params['preference'] = (string) Specifies the node or shard the operation should be performed on.Random by default. (Default = random) * $params['profile'] = (boolean) If `true`, the query execution is profiled. @@ -1617,11 +1617,11 @@ public function update(array $params = []) /** * Performs an update on every document in the index without changing the source,for example to pick up a mapping change. * - * $params['index'] = (array) Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this parameter or use `*` or `_all`. (Required) + * $params['index'] = (array) Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams or indexes, omit this parameter or use `*` or `_all`. (Required) * $params['_source'] = (array) True or false to return the _source field or not, or a list of fields to return. * $params['_source_excludes'] = (array) List of fields to exclude from the returned _source field. * $params['_source_includes'] = (array) List of fields to extract and return from the _source field. - * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.This behavior applies even if the request targets other open indices.For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes.For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. * $params['analyze_wildcard'] = (boolean) If `true`, wildcard and prefix queries are analyzed. (Default = false) * $params['analyzer'] = (string) Analyzer to use for the query string. * $params['conflicts'] = (enum) What to do if update by query hits version conflicts: `abort` or `proceed`. (Options = abort,proceed) @@ -1647,7 +1647,7 @@ public function update(array $params = []) * $params['slices'] = (any) The number of slices this task should be divided into. * $params['sort'] = (array) A comma-separated list of : pairs. * $params['stats'] = (array) Specific `tag` of the request for logging and statistical purposes. - * $params['terminate_after'] = (integer) Maximum number of documents to collect for each shard.If a query reaches this limit, OpenSearch terminates the query early.OpenSearch collects documents before sorting.Use with caution.OpenSearch applies this parameter to each shard handling the request.When possible, let OpenSearch perform early termination automatically.Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + * $params['terminate_after'] = (integer) Maximum number of documents to collect for each shard.If a query reaches this limit, OpenSearch terminates the query early.OpenSearch collects documents before sorting.Use with caution.OpenSearch applies this parameter to each shard handling the request.When possible, let OpenSearch perform early termination automatically.Avoid specifying this parameter for requests that target data streams with backing indexes across multiple data tiers. * $params['timeout'] = (string) Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards. * $params['version'] = (boolean) If `true`, returns the document version as part of a hit. * $params['wait_for_active_shards'] = (any) The number of shard copies that must be active before proceeding with the operation.Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). diff --git a/src/OpenSearch/Namespaces/CatNamespace.php b/src/OpenSearch/Namespaces/CatNamespace.php index a9e38ef7..d9761fc6 100644 --- a/src/OpenSearch/Namespaces/CatNamespace.php +++ b/src/OpenSearch/Namespaces/CatNamespace.php @@ -31,10 +31,10 @@ class CatNamespace extends AbstractNamespace { /** - * Shows information about currently configured aliases to indices including filter and routing infos. + * Shows information about currently configured aliases to indexes including filter and routing info. * * $params['name'] = (array) A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. - * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indices that are open, closed or both. + * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indexes that are open, closed or both. * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) @@ -149,9 +149,9 @@ public function clusterManager(array $params = []) return $this->performRequest($endpoint); } /** - * Provides quick access to the document count of the entire cluster, or individual indices. + * Provides quick access to the document count of the entire cluster, or individual indexes. * - * $params['index'] = (array) Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + * $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`. * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) @@ -255,15 +255,15 @@ public function help(array $params = []) return $this->performRequest($endpoint); } /** - * Returns information about indices: number of primaries and replicas, document counts, disk size, ... + * Returns information about indexes: number of primaries and replicas, document counts, disk size, ... * - * $params['index'] = (array) Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + * $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`. * $params['bytes'] = (enum) The unit used to display byte values. (Options = b,g,gb,k,kb,m,mb,p,pb,t,tb) * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['expand_wildcards'] = (any) The type of index that wildcard patterns can match. * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. * $params['h'] = (array) Comma-separated list of column names to display. - * $params['health'] = (enum) The health status used to limit returned indices. By default, the response includes indices of any health status. (Options = green,red,yellow) + * $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) * $params['help'] = (boolean) Return help information. (Default = false) * $params['include_unloaded_segments'] = (boolean) If true, the response includes information from segments that are not loaded into memory. (Default = false) * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) @@ -468,7 +468,7 @@ public function plugins(array $params = []) /** * Returns information about index shard recoveries, both on-going completed. * - * $params['index'] = (array) A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + * $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`. * $params['active_only'] = (boolean) If `true`, the response only includes ongoing shard recoveries. (Default = false) * $params['bytes'] = (enum) The unit used to display byte values. (Options = b,g,gb,k,kb,m,mb,p,pb,t,tb) * $params['detailed'] = (boolean) If `true`, the response includes detailed information about shard recoveries. (Default = false) @@ -531,16 +531,16 @@ public function repositories(array $params = []) * * $params['index'] = (array) Comma-separated list or wildcard expression of index names to limit the returned information. * $params['active_only'] = (boolean) If `true`, the response only includes ongoing segment replication events. (Default = false) - * $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + * $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). * $params['bytes'] = (enum) The unit in which to display byte values. (Options = b,g,gb,k,kb,m,mb,p,pb,t,tb) * $params['completed_only'] = (boolean) If `true`, the response only includes latest completed segment replication events. (Default = false) * $params['detailed'] = (boolean) If `true`, the response includes detailed information about segment replications. (Default = false) - * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indices that are open, closed or both. + * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indexes that are open, closed or both. * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) - * $params['ignore_throttled'] = (boolean) Whether specified concrete, expanded or aliased indices should be ignored when throttled. - * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed). + * $params['ignore_throttled'] = (boolean) Whether specified concrete, expanded or aliased indexes should be ignored when throttled. + * $params['ignore_unavailable'] = (boolean) Whether specified concrete indexes should be ignored when unavailable (missing or closed). * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. * $params['shards'] = (array) Comma-separated list of shards to display. * $params['time'] = (enum) The unit in which to display time values. (Options = d,h,m,micros,ms,nanos,s) @@ -569,7 +569,7 @@ public function segmentReplication(array $params = []) /** * Provides low-level information about the segments in the shards of an index. * - * $params['index'] = (array) A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + * $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`. * $params['bytes'] = (enum) The unit used to display byte values. (Options = b,g,gb,k,kb,m,mb,p,pb,t,tb) * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. @@ -601,7 +601,7 @@ public function segments(array $params = []) /** * Provides a detailed view of shard allocation on nodes. * - * $params['index'] = (array) A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + * $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`. * $params['bytes'] = (enum) The unit used to display byte values. (Options = b,g,gb,k,kb,m,mb,p,pb,t,tb) * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. diff --git a/src/OpenSearch/Namespaces/ClusterNamespace.php b/src/OpenSearch/Namespaces/ClusterNamespace.php index 016d3e82..ae7c411c 100644 --- a/src/OpenSearch/Namespaces/ClusterNamespace.php +++ b/src/OpenSearch/Namespaces/ClusterNamespace.php @@ -280,11 +280,11 @@ public function getWeightedRouting(array $params = []) /** * Returns basic information about the health of the cluster. * - * $params['index'] = (array) Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`. + * $params['index'] = (array) Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indexes in a cluster, omit this parameter or use `_all` or `*`. * $params['awareness_attribute'] = (string) The awareness attribute for which the health is required. * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. - * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indices that are open, closed or both. - * $params['level'] = (enum) Can be one of cluster, indices or shards. Controls the details level of the health information returned. (Options = awareness_attributes,cluster,indices,shards) + * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indexes that are open, closed or both. + * $params['level'] = (enum) Can be one of cluster, indexes or shards. Controls the details level of the health information returned. (Options = awareness_attributes,cluster,indices,shards) * $params['local'] = (boolean) If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. (Default = false) * $params['master_timeout'] = (string) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. * $params['timeout'] = (string) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. @@ -363,7 +363,7 @@ public function postVotingConfigExclusions(array $params = []) /** * Creates or updates a component template. * - * $params['name'] = (string) Name of the component template to create. OpenSearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`. OpenSearch Agent uses these templates to configure backing indices for its data streams. If you use OpenSearch Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version. If you don't use OpenSearch Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API. + * $params['name'] = (string) Name of the component template to create. OpenSearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`. OpenSearch Agent uses these templates to configure backing indexes for its data streams. If you use OpenSearch Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version. If you don't use OpenSearch Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API. * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['create'] = (boolean) If `true`, this request cannot replace or update existing component templates. (Default = false) * $params['master_timeout'] = (string) Period to wait for a connection to the master node.If no response is received before the timeout expires, the request fails and returns an error. @@ -527,12 +527,12 @@ public function reroute(array $params = []) * Returns a comprehensive information about the state of the cluster. * * $params['metric'] = (array) Limit the information returned to the specified metrics - * $params['index'] = (array) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - * $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + * $params['index'] = (array) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indexes + * $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) * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. - * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indices that are open, closed or both. + * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indexes that are open, closed or both. * $params['flat_settings'] = (boolean) Return settings in flat format. (Default = false) - * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) + * $params['ignore_unavailable'] = (boolean) Whether specified concrete indexes should be ignored when unavailable (missing or closed) * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) * $params['master_timeout'] = (string) Specify timeout for connection to master * $params['wait_for_metadata_version'] = (integer) Wait for the metadata version to be equal or greater than the specified metadata version diff --git a/src/OpenSearch/Namespaces/DanglingIndicesNamespace.php b/src/OpenSearch/Namespaces/DanglingIndicesNamespace.php index 814d99a1..f509eb65 100644 --- a/src/OpenSearch/Namespaces/DanglingIndicesNamespace.php +++ b/src/OpenSearch/Namespaces/DanglingIndicesNamespace.php @@ -87,7 +87,7 @@ public function importDanglingIndex(array $params = []) return $this->performRequest($endpoint); } /** - * Returns all dangling indices. + * Returns all dangling indexes. * * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) diff --git a/src/OpenSearch/Namespaces/IndicesNamespace.php b/src/OpenSearch/Namespaces/IndicesNamespace.php index dff41e4e..da0c9ab7 100644 --- a/src/OpenSearch/Namespaces/IndicesNamespace.php +++ b/src/OpenSearch/Namespaces/IndicesNamespace.php @@ -34,11 +34,11 @@ class IndicesNamespace extends AbstractNamespace * Adds a block to an index. * * $params['block'] = (string) The block to add (one of read, write, read_only or metadata) - * $params['index'] = (array) A comma separated list of indices to add a block to - * $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + * $params['index'] = (array) A comma separated list of indexes to add a block to + * $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) * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. - * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indices that are open, closed or both. - * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) + * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indexes that are open, closed or both. + * $params['ignore_unavailable'] = (boolean) Whether specified concrete indexes should be ignored when unavailable (missing or closed) * $params['master_timeout'] = (string) Specify timeout for connection to master * $params['timeout'] = (string) Explicit operation timeout * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) @@ -91,10 +91,10 @@ public function analyze(array $params = []) return $this->performRequest($endpoint); } /** - * Clears all or specific caches for one or more indices. + * Clears all or specific caches for one or more indexes. * - * $params['index'] = (array) Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. - * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.This behavior applies even if the request targets other open indices. + * $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`. + * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes. * $params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as `open,hidden`.Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * $params['fielddata'] = (boolean) If `true`, clears the fields cache.Use the `fields` parameter to clear the cache of specific fields only. * $params['fields'] = (any) Comma-separated list of field names used to limit the `fielddata` parameter. @@ -162,7 +162,7 @@ public function clone(array $params = []) * Closes an index. * * $params['index'] = (array) Comma-separated list or wildcard expression of index names used to limit the request. - * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.This behavior applies even if the request targets other open indices. + * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes. * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as `open,hidden`.Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * $params['ignore_unavailable'] = (boolean) If `false`, the request returns an error if it targets a missing or closed index. @@ -274,8 +274,8 @@ public function dataStreamsStats(array $params = []) /** * Deletes an index. * - * $params['index'] = (array) Comma-separated list of indices to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (`*`) or `_all`. To use wildcards or `_all`, set the `action.destructive_requires_name` cluster setting to `false`. - * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.This behavior applies even if the request targets other open indices. (Default = false) + * $params['index'] = (array) Comma-separated list of indexes to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (`*`) or `_all`. To use wildcards or `_all`, set the `action.destructive_requires_name` cluster setting to `false`. + * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes. (Default = false) * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as `open,hidden`.Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * $params['ignore_unavailable'] = (boolean) If `false`, the request returns an error if it targets a missing or closed index. (Default = false) @@ -304,7 +304,7 @@ public function delete(array $params = []) /** * Deletes an alias. * - * $params['index'] = (array) Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). (Required) + * $params['index'] = (array) Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (`*`). (Required) * $params['name'] = (array) Comma-separated list of aliases to remove. Supports wildcards (`*`). To remove all aliases, use `*` or `_all`. (Required) * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['master_timeout'] = (string) Period to wait for a connection to the master node.If no response is received before the timeout expires, the request fails and returns an error. @@ -412,8 +412,8 @@ public function deleteTemplate(array $params = []) /** * Returns information about whether a particular index exists. * - * $params['index'] = (array) Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). - * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.This behavior applies even if the request targets other open indices. (Default = false) + * $params['index'] = (array) Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). + * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes. (Default = false) * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as `open,hidden`.Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * $params['flat_settings'] = (boolean) If `true`, returns settings in flat format. (Default = false) @@ -447,10 +447,10 @@ public function exists(array $params = []): bool * Returns information about whether a particular alias exists. * * $params['name'] = (array) Comma-separated list of aliases to check. Supports wildcards (`*`). (Required) - * $params['index'] = (array) Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. - * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.This behavior applies even if the request targets other open indices. + * $params['index'] = (array) Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. + * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes. * $params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as `open,hidden`.Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - * $params['ignore_unavailable'] = (boolean) If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. + * $params['ignore_unavailable'] = (boolean) If `false`, requests that include a missing data stream or index in the target indexes or data streams return an error. * $params['local'] = (boolean) If `true`, the request retrieves information from the local node only. (Default = false) * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) @@ -540,10 +540,10 @@ public function existsTemplate(array $params = []): bool return BooleanRequestWrapper::performRequest($endpoint, $this->transport); } /** - * Performs the flush operation on one or more indices. + * Performs the flush operation on one or more indexes. * - * $params['index'] = (array) Comma-separated list of data streams, indices, and aliases to flush. Supports wildcards (`*`). To flush all data streams and indices, omit this parameter or use `*` or `_all`. - * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.This behavior applies even if the request targets other open indices. + * $params['index'] = (array) Comma-separated list of data streams, indexes, and aliases to flush. Supports wildcards (`*`). To flush all data streams and indexes, omit this parameter or use `*` or `_all`. + * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes. * $params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as `open,hidden`.Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * $params['force'] = (boolean) If `true`, the request forces a flush even if there are no changes to commit to the index. * $params['ignore_unavailable'] = (boolean) If `false`, the request returns an error if it targets a missing or closed index. @@ -569,13 +569,13 @@ public function flush(array $params = []) return $this->performRequest($endpoint); } /** - * Performs the force merge operation on one or more indices. + * Performs the force merge operation on one or more indexes. * - * $params['index'] = (array) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - * $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indices that are open, closed or both. + * $params['index'] = (array) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indexes + * $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) + * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indexes that are open, closed or both. * $params['flush'] = (boolean) Specify whether the index should be flushed after performing the operation. (Default = true) - * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) + * $params['ignore_unavailable'] = (boolean) Whether specified concrete indexes should be ignored when unavailable (missing or closed) * $params['max_num_segments'] = (number) The number of larger segments into which smaller segments are merged.Set this parameter to 1 to merge all segments into one segment.The default behavior is to perform the merge as necessary. * $params['only_expunge_deletes'] = (boolean) Specify whether the operation should only expunge deleted documents * $params['primary_only'] = (boolean) Specify whether the operation should only perform on primary shards. Defaults to false. (Default = false) @@ -601,10 +601,10 @@ public function forcemerge(array $params = []) return $this->performRequest($endpoint); } /** - * Returns information about one or more indices. + * Returns information about one or more indexes. * - * $params['index'] = (array) Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. - * $params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, index alias, or _all value targets onlymissing or closed indices. This behavior applies even if the request targets other open indices. For example,a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. (Default = false) + * $params['index'] = (array) Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard expressions (*) are supported. + * $params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, index alias, or _all value targets onlymissing or closed indexes. This behavior applies even if the request targets other open indexes. For example,a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. (Default = false) * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['expand_wildcards'] = (any) Type of index that wildcard expressions can match. If the request can target data streams, this argumentdetermines whether wildcard expressions match hidden data streams. Supports comma-separated values,such as open,hidden. * $params['flat_settings'] = (boolean) If true, returns settings in flat format. (Default = false) @@ -636,8 +636,8 @@ public function get(array $params = []) * Returns an alias. * * $params['name'] = (array) Comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. - * $params['index'] = (array) Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. - * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.This behavior applies even if the request targets other open indices. + * $params['index'] = (array) Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. + * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes. * $params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as `open,hidden`.Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * $params['ignore_unavailable'] = (boolean) If `false`, the request returns an error if it targets a missing or closed index. * $params['local'] = (boolean) If `true`, the request retrieves information from the local node only. (Default = false) @@ -691,8 +691,8 @@ public function getDataStream(array $params = []) * Returns mapping for one or more fields. * * $params['fields'] = (array) Comma-separated list or wildcard expression of fields used to limit returned information. (Required) - * $params['index'] = (array) Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. - * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.This behavior applies even if the request targets other open indices. + * $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`. + * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes. * $params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as `open,hidden`.Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * $params['ignore_unavailable'] = (boolean) If `false`, the request returns an error if it targets a missing or closed index. * $params['include_defaults'] = (boolean) If `true`, return all default settings in the response. @@ -748,10 +748,10 @@ public function getIndexTemplate(array $params = []) return $this->performRequest($endpoint); } /** - * Returns mappings for one or more indices. + * Returns mappings for one or more indexes. * - * $params['index'] = (array) Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. - * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.This behavior applies even if the request targets other open indices. + * $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`. + * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes. * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as `open,hidden`.Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * $params['ignore_unavailable'] = (boolean) If `false`, the request returns an error if it targets a missing or closed index. @@ -778,11 +778,11 @@ public function getMapping(array $params = []) return $this->performRequest($endpoint); } /** - * Returns settings for one or more indices. + * Returns settings for one or more indexes. * * $params['name'] = (array) Comma-separated list or wildcard expression of settings to retrieve. - * $params['index'] = (array) Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. - * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, indexalias, or `_all` value targets only missing or closed indices. Thisbehavior applies even if the request targets other open indices. Forexample, a request targeting `foo*,bar*` returns an error if an indexstarts with foo but no index starts with `bar`. + * $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`. + * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, indexalias, or `_all` value targets only missing or closed indexes. Thisbehavior applies even if the request targets other open indexes. Forexample, a request targeting `foo*,bar*` returns an error if an indexstarts with foo but no index starts with `bar`. * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as `open,hidden`. * $params['flat_settings'] = (boolean) If `true`, returns settings in flat format. (Default = false) @@ -843,10 +843,10 @@ public function getTemplate(array $params = []) /** * The _upgrade API is no longer useful and will be removed. * - * $params['index'] = (array) Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. - * $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). - * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indices that are open, closed or both. - * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed). + * $params['index'] = (array) Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. + * $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). + * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indexes that are open, closed or both. + * $params['ignore_unavailable'] = (boolean) Whether specified concrete indexes should be ignored when unavailable (missing or closed). * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) @@ -870,8 +870,8 @@ public function getUpgrade(array $params = []) /** * Opens an index. * - * $params['index'] = (array) Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). By default, you must explicitly name the indices you using to limit the request. To limit a request using `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to false. You can update this setting in the `opensearch.yml` file or using the cluster update settings API. - * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.This behavior applies even if the request targets other open indices. + * $params['index'] = (array) Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). By default, you must explicitly name the indexes you using to limit the request. To limit a request using `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to false. You can update this setting in the `opensearch.yml` file or using the cluster update settings API. + * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes. * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as `open,hidden`.Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * $params['ignore_unavailable'] = (boolean) If `false`, the request returns an error if it targets a missing or closed index. @@ -904,7 +904,7 @@ public function open(array $params = []) * Creates or updates an alias. * * $params['name'] = (string) Alias to update. If the alias doesn't exist, the request creates it. Index alias names support date math. - * $params['index'] = (array) Comma-separated list of data streams or indices to add. Supports wildcards (`*`). Wildcard patterns that match both data streams and indices return an error. + * $params['index'] = (array) Comma-separated list of data streams or indexes to add. Supports wildcards (`*`). Wildcard patterns that match both data streams and indexes return an error. * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['master_timeout'] = (string) Period to wait for a connection to the master node.If no response is received before the timeout expires, the request fails and returns an error. * $params['timeout'] = (string) Period to wait for a response.If no response is received before the timeout expires, the request fails and returns an error. @@ -967,8 +967,8 @@ public function putIndexTemplate(array $params = []) /** * Updates the index mappings. * - * $params['index'] = (array) A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. - * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.This behavior applies even if the request targets other open indices. + * $params['index'] = (array) A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indexes. + * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes. * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as `open,hidden`.Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * $params['ignore_unavailable'] = (boolean) If `false`, the request returns an error if it targets a missing or closed index. @@ -1001,12 +1001,12 @@ public function putMapping(array $params = []) /** * Updates the index settings. * - * $params['index'] = (array) Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. - * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, indexalias, or `_all` value targets only missing or closed indices. Thisbehavior applies even if the request targets other open indices. Forexample, a request targeting `foo*,bar*` returns an error if an indexstarts with `foo` but no index starts with `bar`. + * $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`. + * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, indexalias, or `_all` value targets only missing or closed indexes. Thisbehavior applies even if the request targets other open indexes. Forexample, a request targeting `foo*,bar*` returns an error if an indexstarts with `foo` but no index starts with `bar`. * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['expand_wildcards'] = (any) Type of index that wildcard patterns can match. If the request can targetdata streams, this argument determines whether wildcard expressions matchhidden data streams. Supports comma-separated values, such as`open,hidden`. * $params['flat_settings'] = (boolean) If `true`, returns settings in flat format. (Default = false) - * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed). + * $params['ignore_unavailable'] = (boolean) Whether specified concrete indexes should be ignored when unavailable (missing or closed). * $params['master_timeout'] = (string) Period to wait for a connection to the master node. If no response isreceived before the timeout expires, the request fails and returns anerror. * $params['preserve_existing'] = (boolean) If `true`, existing index settings remain unchanged. (Default = false) * $params['timeout'] = (string) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. @@ -1066,7 +1066,7 @@ public function putTemplate(array $params = []) /** * Returns information about ongoing index shard recoveries. * - * $params['index'] = (array) Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + * $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`. * $params['active_only'] = (boolean) If `true`, the response only includes ongoing shard recoveries. (Default = false) * $params['detailed'] = (boolean) If `true`, the response includes detailed information about shard recoveries. (Default = false) * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) @@ -1090,10 +1090,10 @@ public function recovery(array $params = []) return $this->performRequest($endpoint); } /** - * Performs the refresh operation in one or more indices. + * Performs the refresh operation in one or more indexes. * - * $params['index'] = (array) Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. - * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.This behavior applies even if the request targets other open indices. + * $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`. + * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes. * $params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as `open,hidden`.Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * $params['ignore_unavailable'] = (boolean) If `false`, the request returns an error if it targets a missing or closed index. * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) @@ -1117,9 +1117,9 @@ public function refresh(array $params = []) return $this->performRequest($endpoint); } /** - * Returns information about any matching indices, aliases, and data streams. + * Returns information about any matching indexes, aliases, and data streams. * - * $params['name'] = (array) Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the ``:`` syntax. + * $params['name'] = (array) Comma-separated name(s) or index pattern(s) of the indexes, aliases, and data streams to resolve. Resources on remote clusters can be specified using the ``:`` syntax. * $params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as `open,hidden`.Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) @@ -1179,8 +1179,8 @@ public function rollover(array $params = []) /** * Provides low-level information about segments in a Lucene index. * - * $params['index'] = (array) Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. - * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.This behavior applies even if the request targets other open indices. + * $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`. + * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes. * $params['expand_wildcards'] = (any) Type of index that wildcard patterns can match.If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.Supports comma-separated values, such as `open,hidden`.Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * $params['ignore_unavailable'] = (boolean) If `false`, the request returns an error if it targets a missing or closed index. * $params['verbose'] = (boolean) If `true`, the request returns a verbose response. (Default = false) @@ -1205,12 +1205,12 @@ public function segments(array $params = []) return $this->performRequest($endpoint); } /** - * Provides store information for shard copies of indices. + * Provides store information for shard copies of indexes. * - * $params['index'] = (array) List of data streams, indices, and aliases used to limit the request. - * $params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, index alias, or _allvalue targets only missing or closed indices. This behavior applies even if the requesttargets other open indices. + * $params['index'] = (array) List of data streams, indexes, and aliases used to limit the request. + * $params['allow_no_indices'] = (boolean) If false, the request returns an error if any wildcard expression, index alias, or _allvalue targets only missing or closed indexes. This behavior applies even if the requesttargets other open indexes. * $params['expand_wildcards'] = (any) Type of index that wildcard patterns can match. If the request can target data streams,this argument determines whether wildcard expressions match hidden data streams. - * $params['ignore_unavailable'] = (boolean) If true, missing or closed indices are not included in the response. + * $params['ignore_unavailable'] = (boolean) If true, missing or closed indexes are not included in the response. * $params['status'] = (any) List of shard health statuses used to limit the request. * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) @@ -1371,12 +1371,12 @@ public function split(array $params = []) * Provides statistics on operations happening in an index. * * $params['metric'] = (array) Limit the information returned the specific metrics. - * $params['index'] = (array) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices + * $params['index'] = (array) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indexes * $params['completion_fields'] = (any) Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. * $params['expand_wildcards'] = (any) Type of index that wildcard patterns can match. If the request can target data streams, this argumentdetermines whether wildcard expressions match hidden data streams. Supports comma-separated values,such as `open,hidden`. * $params['fielddata_fields'] = (any) Comma-separated list or wildcard expressions of fields to include in fielddata statistics. * $params['fields'] = (any) Comma-separated list or wildcard expressions of fields to include in the statistics. - * $params['forbid_closed_indices'] = (boolean) If true, statistics are not collected from closed indices. (Default = true) + * $params['forbid_closed_indices'] = (boolean) If true, statistics are not collected from closed indexes. (Default = true) * $params['groups'] = (any) Comma-separated list of search groups to include in the search statistics. * $params['include_segment_file_sizes'] = (boolean) If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). (Default = false) * $params['include_unloaded_segments'] = (boolean) If true, the response includes information from segments that are not loaded into memory. (Default = false) @@ -1433,10 +1433,10 @@ public function updateAliases(array $params = []) /** * The _upgrade API is no longer useful and will be removed. * - * $params['index'] = (array) Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. - * $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). - * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indices that are open, closed or both. - * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed). + * $params['index'] = (array) Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. + * $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). + * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indexes that are open, closed or both. + * $params['ignore_unavailable'] = (boolean) Whether specified concrete indexes should be ignored when unavailable (missing or closed). * $params['only_ancient_segments'] = (boolean) If true, only ancient (an older Lucene major release) segments will be upgraded. * $params['wait_for_completion'] = (boolean) Should this request wait until the operation has completed before returning. (Default = false) * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) @@ -1462,9 +1462,9 @@ public function upgrade(array $params = []) /** * Allows a user to validate a potentially expensive query without executing it. * - * $params['index'] = (array) Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this parameter or use `*` or `_all`. + * $params['index'] = (array) Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams or indexes, omit this parameter or use `*` or `_all`. * $params['all_shards'] = (boolean) If `true`, the validation is executed on all shards instead of one random shard per index. - * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.This behavior applies even if the request targets other open indices. + * $params['allow_no_indices'] = (boolean) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes.This behavior applies even if the request targets other open indexes. * $params['analyze_wildcard'] = (boolean) If `true`, wildcard and prefix queries are analyzed. (Default = false) * $params['analyzer'] = (string) Analyzer to use for the query string.This parameter can only be used when the `q` query string parameter is specified. * $params['default_operator'] = (enum) The default operator for query string query: `AND` or `OR`. (Options = and,or) diff --git a/src/OpenSearch/Namespaces/IsmNamespace.php b/src/OpenSearch/Namespaces/IsmNamespace.php index 13d55588..f0f1f0fb 100644 --- a/src/OpenSearch/Namespaces/IsmNamespace.php +++ b/src/OpenSearch/Namespaces/IsmNamespace.php @@ -27,7 +27,7 @@ class IsmNamespace extends AbstractNamespace /** * Adds a policy to an index. * - * $params['index'] = (string) Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + * $params['index'] = (string) Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) @@ -53,7 +53,7 @@ public function addPolicy(array $params = []) /** * Updates the managed index policy to a new policy. * - * $params['index'] = (string) Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + * $params['index'] = (string) Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) @@ -130,7 +130,7 @@ public function existsPolicy(array $params = []): bool /** * Gets the currently applied policy on indices. * - * $params['index'] = (string) Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + * $params['index'] = (string) Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) @@ -254,7 +254,7 @@ public function putPolicy(array $params = []) /** * Refresh search analyzers in real time. * - * $params['index'] = (string) Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). (Required) + * $params['index'] = (string) Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). (Required) * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) @@ -278,7 +278,7 @@ public function refreshSearchAnalyzers(array $params = []) /** * Removes a policy from an index. * - * $params['index'] = (string) Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + * $params['index'] = (string) Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) @@ -302,7 +302,7 @@ public function removePolicy(array $params = []) /** * Retry the failed action for an index. * - * $params['index'] = (string) Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + * $params['index'] = (string) Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) diff --git a/src/OpenSearch/Namespaces/KnnNamespace.php b/src/OpenSearch/Namespaces/KnnNamespace.php index 4175a572..a6691899 100644 --- a/src/OpenSearch/Namespaces/KnnNamespace.php +++ b/src/OpenSearch/Namespaces/KnnNamespace.php @@ -78,7 +78,7 @@ public function getModel(array $params = []) * $params['_source'] = (array) True or false to return the _source field or not, or a list of fields to return. * $params['_source_excludes'] = (array) List of fields to exclude from the returned _source field. * $params['_source_includes'] = (array) List of fields to extract and return from the _source field. - * $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + * $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). * $params['allow_partial_search_results'] = (boolean) Indicate if an error should be returned if there is a partial search failure or timeout. (Default = true) * $params['analyze_wildcard'] = (boolean) Specify whether wildcard and prefix queries should be analyzed. (Default = false) * $params['analyzer'] = (string) The analyzer to use for the query string. @@ -87,11 +87,11 @@ public function getModel(array $params = []) * $params['default_operator'] = (enum) The default operator for query string query (AND or OR). (Options = AND,OR) * $params['df'] = (string) The field to use as default where no field prefix is given in the query string. * $params['docvalue_fields'] = (array) Comma-separated list of fields to return as the docvalue representation of a field for each hit. - * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indices that are open, closed or both. + * $params['expand_wildcards'] = (any) Whether to expand wildcard expression to concrete indexes that are open, closed or both. * $params['explain'] = (boolean) Specify whether to return detailed information about score computation as part of a hit. * $params['from'] = (integer) Starting offset. (Default = 0) - * $params['ignore_throttled'] = (boolean) Whether specified concrete, expanded or aliased indices should be ignored when throttled. - * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed). + * $params['ignore_throttled'] = (boolean) Whether specified concrete, expanded or aliased indexes should be ignored when throttled. + * $params['ignore_unavailable'] = (boolean) Whether specified concrete indexes should be ignored when unavailable (missing or closed). * $params['lenient'] = (boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored. * $params['max_concurrent_shard_requests'] = (integer) The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. (Default = 5) * $params['pre_filter_shard_size'] = (integer) Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. @@ -195,7 +195,7 @@ public function trainModel(array $params = []) /** * Preloads native library files into memory, reducing initial search latency for specified indexes. * - * $params['index'] = (array) Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. (Required) + * $params['index'] = (array) Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. (Required) * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) diff --git a/src/OpenSearch/Namespaces/NodesNamespace.php b/src/OpenSearch/Namespaces/NodesNamespace.php index 40486557..b3073824 100644 --- a/src/OpenSearch/Namespaces/NodesNamespace.php +++ b/src/OpenSearch/Namespaces/NodesNamespace.php @@ -125,7 +125,7 @@ public function reloadSecureSettings(array $params = []) * * $params['node_id'] = (array) Comma-separated list of node IDs or names used to limit returned information. * $params['metric'] = (array) Limit the information returned to the specified metrics - * $params['index_metric'] = (array) Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified. + * $params['index_metric'] = (array) Limit the information returned for indexes metric to the specific index metrics. It can be used only if indexes (or all) metric is specified. * $params['completion_fields'] = (any) Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. * $params['fielddata_fields'] = (any) Comma-separated list or wildcard expressions of fields to include in fielddata statistics. * $params['fields'] = (any) Comma-separated list or wildcard expressions of fields to include in the statistics. diff --git a/src/OpenSearch/Namespaces/SecurityNamespace.php b/src/OpenSearch/Namespaces/SecurityNamespace.php index a7fb5b38..78fe1186 100644 --- a/src/OpenSearch/Namespaces/SecurityNamespace.php +++ b/src/OpenSearch/Namespaces/SecurityNamespace.php @@ -130,7 +130,7 @@ public function configUpgradePerform(array $params = []) return $this->performRequest($endpoint); } /** - * Creates or replaces the allowlisted APIs. Accessible via Super Admin certificate or REST API permission. + * Creates or replaces the permitted APIs. Accessible using Super Admin certificate or REST API permission. * * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) diff --git a/src/OpenSearch/Namespaces/SnapshotNamespace.php b/src/OpenSearch/Namespaces/SnapshotNamespace.php index fc430071..c7719688 100644 --- a/src/OpenSearch/Namespaces/SnapshotNamespace.php +++ b/src/OpenSearch/Namespaces/SnapshotNamespace.php @@ -58,7 +58,7 @@ public function cleanupRepository(array $params = []) return $this->performRequest($endpoint); } /** - * Clones indices from one snapshot into another snapshot in the same repository. + * Clones indexes from one snapshot into another snapshot in the same repository. * * $params['repository'] = (string) A repository name * $params['snapshot'] = (string) The name of the snapshot to clone from diff --git a/src/OpenSearch/Namespaces/WlmNamespace.php b/src/OpenSearch/Namespaces/WlmNamespace.php index cc45875b..7eadb949 100644 --- a/src/OpenSearch/Namespaces/WlmNamespace.php +++ b/src/OpenSearch/Namespaces/WlmNamespace.php @@ -25,7 +25,7 @@ class WlmNamespace extends AbstractNamespace { /** - * Creates the specified query group. + * Creates a new query group and sets the resource limits for the new query group. * * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) @@ -48,9 +48,9 @@ public function createQueryGroup(array $params = []) return $this->performRequest($endpoint); } /** - * Deletes the specified QueryGroup. + * Deletes the specified query group. * - * $params['name'] = (string) QueryGroup name. + * $params['name'] = (string) The name of the query group. * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) @@ -72,9 +72,9 @@ public function deleteQueryGroup(array $params = []) return $this->performRequest($endpoint); } /** - * Gets the specified QueryGroup or get all if no name is provided. + * Retrieves the specified query group. If no query group is specified, all query groups in the cluster are retrieved. * - * $params['name'] = (string) QueryGroup name. + * $params['name'] = (string) The name of the query group. * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) @@ -98,7 +98,7 @@ public function getQueryGroup(array $params = []) /** * Updates the specified query group. * - * $params['name'] = (string) QueryGroup name. + * $params['name'] = (string) The name of the query group. * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)