From aaac1cc537f7f1d7718a86432422a03695a18a42 Mon Sep 17 00:00:00 2001 From: dblock Date: Fri, 22 Nov 2024 03:41:46 +0000 Subject: [PATCH] Updated opensearch-php to reflect the latest OpenSearch API spec (2024-11-22) Signed-off-by: GitHub --- CHANGELOG.md | 1 + src/OpenSearch/Client.php | 112 ++++--- src/OpenSearch/Endpoints/Cat/Master.php | 2 +- .../Endpoints/Replication/AutofollowStats.php | 45 +++ .../Replication/CreateReplicationRule.php | 55 ++++ .../Replication/DeleteReplicationRule.php | 55 ++++ .../Endpoints/Replication/FollowerStats.php | 45 +++ .../Endpoints/Replication/LeaderStats.php | 45 +++ .../Endpoints/Replication/Pause.php | 60 ++++ .../Endpoints/Replication/Resume.php | 60 ++++ .../Endpoints/Replication/Start.php | 60 ++++ .../Endpoints/Replication/Status.php | 50 +++ src/OpenSearch/Endpoints/Replication/Stop.php | 60 ++++ .../Endpoints/Replication/UpdateSettings.php | 60 ++++ src/OpenSearch/Namespaces/CatNamespace.php | 82 ++--- .../Namespaces/ClusterNamespace.php | 54 ++-- .../Namespaces/DanglingIndicesNamespace.php | 16 +- .../Namespaces/FlowFrameworkNamespace.php | 4 +- .../Namespaces/IndicesNamespace.php | 114 +++---- src/OpenSearch/Namespaces/IngestNamespace.php | 6 +- src/OpenSearch/Namespaces/IsmNamespace.php | 2 +- src/OpenSearch/Namespaces/KnnNamespace.php | 10 +- src/OpenSearch/Namespaces/ListNamespace.php | 8 +- src/OpenSearch/Namespaces/NodesNamespace.php | 14 +- src/OpenSearch/Namespaces/PplNamespace.php | 8 +- .../Namespaces/ReplicationNamespace.php | 287 ++++++++++++++++++ .../Namespaces/SecurityNamespace.php | 18 +- .../Namespaces/SnapshotNamespace.php | 30 +- src/OpenSearch/Namespaces/SqlNamespace.php | 8 +- .../Namespaces/TransformsNamespace.php | 2 +- 30 files changed, 1135 insertions(+), 238 deletions(-) create mode 100644 src/OpenSearch/Endpoints/Replication/AutofollowStats.php create mode 100644 src/OpenSearch/Endpoints/Replication/CreateReplicationRule.php create mode 100644 src/OpenSearch/Endpoints/Replication/DeleteReplicationRule.php create mode 100644 src/OpenSearch/Endpoints/Replication/FollowerStats.php create mode 100644 src/OpenSearch/Endpoints/Replication/LeaderStats.php create mode 100644 src/OpenSearch/Endpoints/Replication/Pause.php create mode 100644 src/OpenSearch/Endpoints/Replication/Resume.php create mode 100644 src/OpenSearch/Endpoints/Replication/Start.php create mode 100644 src/OpenSearch/Endpoints/Replication/Status.php create mode 100644 src/OpenSearch/Endpoints/Replication/Stop.php create mode 100644 src/OpenSearch/Endpoints/Replication/UpdateSettings.php create mode 100644 src/OpenSearch/Namespaces/ReplicationNamespace.php diff --git a/CHANGELOG.md b/CHANGELOG.md index c7334481..fa5533e1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,6 +18,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@22bdd5c](https://github.com/opensearch-project/opensearch-api-specification/commit/22bdd5cc15fce7895b9a0baddd989798fca29899) - 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) diff --git a/src/OpenSearch/Client.php b/src/OpenSearch/Client.php index 43d5aa57..39696ec3 100644 --- a/src/OpenSearch/Client.php +++ b/src/OpenSearch/Client.php @@ -47,6 +47,7 @@ use OpenSearch\Namespaces\PplNamespace; use OpenSearch\Namespaces\QueryNamespace; use OpenSearch\Namespaces\RemoteStoreNamespace; +use OpenSearch\Namespaces\ReplicationNamespace; use OpenSearch\Namespaces\RollupsNamespace; use OpenSearch\Namespaces\SearchPipelineNamespace; use OpenSearch\Namespaces\SearchableSnapshotsNamespace; @@ -197,6 +198,11 @@ class Client */ protected $remoteStore; + /** + * @var ReplicationNamespace + */ + protected $replication; + /** * @var RollupsNamespace */ @@ -291,6 +297,7 @@ public function __construct(Transport $transport, callable|EndpointFactoryInterf $this->ppl = new PplNamespace($transport, $this->endpointFactory); $this->query = new QueryNamespace($transport, $this->endpointFactory); $this->remoteStore = new RemoteStoreNamespace($transport, $this->endpointFactory); + $this->replication = new ReplicationNamespace($transport, $this->endpointFactory); $this->rollups = new RollupsNamespace($transport, $this->endpointFactory); $this->searchPipeline = new SearchPipelineNamespace($transport, $this->endpointFactory); $this->searchableSnapshots = new SearchableSnapshotsNamespace($transport, $this->endpointFactory); @@ -313,7 +320,7 @@ public function __construct(Transport $transport, callable|EndpointFactoryInterf * $params['_source_excludes'] = (any) A comma-separated list of source fields to exclude from the response. * $params['_source_includes'] = (any) A comma-separated list of source fields to include in the response. * $params['pipeline'] = (string) ID of the pipeline to use to preprocess incoming documents.If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.If a final pipeline is configured it will always run, regardless of the value of this parameter. - * $params['refresh'] = (enum) If `true`, OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.Valid values: `true`, `false`, `wait_for`. (Options = false,true,wait_for) + * $params['refresh'] = (any) If `true`, OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.Valid values: `true`, `false`, `wait_for`. * $params['require_alias'] = (boolean) If `true`, the request's actions must target an index alias. (Default = false) * $params['routing'] = (any) Custom value used to route operations to a specific shard. * $params['timeout'] = (string) Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. @@ -351,7 +358,7 @@ public function bulk(array $params = []) * $params['batch_interval'] = (string) Specifies for how long bulk operations should be accumulated into a batch before sending the batch to data nodes. * $params['batch_size'] = (integer) Specifies how many bulk operations should be accumulated into a batch before sending the batch to data nodes. * $params['pipeline'] = (string) ID of the pipeline to use to preprocess incoming documents.If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.If a final pipeline is configured it will always run, regardless of the value of this parameter. - * $params['refresh'] = (enum) If `true`, OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.Valid values: `true`, `false`, `wait_for`. (Options = false,true,wait_for) + * $params['refresh'] = (any) If `true`, OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.Valid values: `true`, `false`, `wait_for`. * $params['require_alias'] = (boolean) If `true`, the request's actions must target an index alias. (Default = false) * $params['routing'] = (any) Custom value used to route operations to a specific shard. * $params['timeout'] = (string) Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. @@ -483,7 +490,7 @@ public function createPit(array $params = []) * $params['index'] = (string) Name of the target index. (Required) * $params['if_primary_term'] = (integer) Only perform the operation if the document has this primary term. * $params['if_seq_no'] = (integer) Only perform the operation if the document has this sequence number. - * $params['refresh'] = (enum) If `true`, OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.Valid values: `true`, `false`, `wait_for`. (Options = false,true,wait_for) + * $params['refresh'] = (any) If `true`, OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.Valid values: `true`, `false`, `wait_for`. * $params['routing'] = (any) Custom value used to route operations to a specific shard. * $params['timeout'] = (string) Period to wait for active shards. * $params['version'] = (integer) Explicit version number for concurrency control.The specified version must match the current version of the document for the request to succeed. @@ -535,9 +542,9 @@ public function deleteAllPits(array $params = []) * Deletes documents matching the provided query. * * $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['_source'] = (array) Set to `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 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. @@ -551,7 +558,7 @@ public function deleteAllPits(array $params = []) * $params['max_docs'] = (integer) Maximum number of documents to process.Defaults to all documents. * $params['preference'] = (string) Specifies the node or shard the operation should be performed on.Random by default. (Default = random) * $params['q'] = (string) Query in the Lucene query string syntax. - * $params['refresh'] = (boolean) If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. + * $params['refresh'] = (any) If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. * $params['request_cache'] = (boolean) If `true`, the request cache is used for this request.Defaults to the index-level setting. * $params['requests_per_second'] = (number) The throttle for this request in sub-requests per second. (Default = 0) * $params['routing'] = (any) Custom value used to route operations to a specific shard. @@ -559,7 +566,7 @@ public function deleteAllPits(array $params = []) * $params['scroll_size'] = (integer) Size of the scroll request that powers the operation. (Default = 100) * $params['search_timeout'] = (string) Explicit timeout for each search request.Defaults to no timeout. * $params['search_type'] = (enum) The type of the search operation.Available options: `query_then_fetch`, `dfs_query_then_fetch`. (Options = dfs_query_then_fetch,query_then_fetch) - * $params['size'] = (integer) Deprecated, please use `max_docs` instead. + * $params['size'] = (integer) Deprecated, use `max_docs` instead. * $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. @@ -645,7 +652,7 @@ public function deletePit(array $params = []) * * $params['id'] = (string) Identifier for the stored script or search template. (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. + * $params['master_timeout'] = (string) Period to wait for a connection to the cluster-manager 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. * $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) @@ -677,7 +684,7 @@ public function deleteScript(array $params = []) * $params['_source_includes'] = (any) A comma-separated list of source fields to include in the response. * $params['preference'] = (string) Specifies the node or shard the operation should be performed on.Random by default. (Default = random) * $params['realtime'] = (boolean) If `true`, the request is real-time as opposed to near-real-time. - * $params['refresh'] = (boolean) If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. + * $params['refresh'] = (any) If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. * $params['routing'] = (any) Target the specified primary shard. * $params['stored_fields'] = (any) List of stored fields to return as part of a hit.If no fields are specified, no stored fields are included in the response.If this field is specified, the `_source` parameter defaults to false. * $params['version'] = (integer) Explicit version number for concurrency control.The specified version must match the current version of the document for the request to succeed. @@ -716,8 +723,8 @@ public function exists(array $params = []): bool * $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. * $params['preference'] = (string) Specifies the node or shard the operation should be performed on.Random by default. (Default = random) - * $params['realtime'] = (boolean) If true, the request is real-time as opposed to near-real-time. - * $params['refresh'] = (boolean) If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. + * $params['realtime'] = (boolean) If `true`, the request is real-time as opposed to near-real-time. + * $params['refresh'] = (any) If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. * $params['routing'] = (any) Target the specified primary shard. * $params['version'] = (integer) Explicit version number for concurrency control.The specified version must match the current version of the document for the request to succeed. * $params['version_type'] = (enum) Specific version type: `external`, `external_gte`. (Options = external,external_gte,force,internal) @@ -751,7 +758,7 @@ public function existsSource(array $params = []): bool * * $params['id'] = (string) Defines the document ID. (Required) * $params['index'] = (string) Index names used to limit the request. Only a single index name can be provided to this parameter. (Required) - * $params['_source'] = (any) True or false to return the `_source` field or not, or a list of fields to return. + * $params['_source'] = (any) Set to `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 from the response. * $params['_source_includes'] = (any) A comma-separated list of source fields to include in the response. * $params['analyze_wildcard'] = (boolean) If `true`, wildcard and prefix queries are analyzed. (Default = false) @@ -791,12 +798,12 @@ public function explain(array $params = []) /** * Returns the information about the capabilities of fields among multiple indexes. * - * $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['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 indexes are not included in the response. - * $params['include_unmapped'] = (boolean) If true, unmapped fields are included in the response. (Default = false) + * $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) * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) @@ -825,16 +832,16 @@ public function fieldCaps(array $params = []) * * $params['id'] = (string) Unique identifier of the document. (Required) * $params['index'] = (string) Name of the index that contains the document. (Required) - * $params['_source'] = (any) True or false to return the _source field or not, or a list of fields to return. + * $params['_source'] = (any) Set to `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. * $params['preference'] = (string) Specifies the node or shard the operation should be performed on. Random by default. (Default = random) * $params['realtime'] = (boolean) If `true`, the request is real-time as opposed to near-real-time. - * $params['refresh'] = (boolean) If true, OpenSearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + * $params['refresh'] = (any) If `true`, OpenSearch refreshes the affected shards to make this operation visible to search. If `false`, do nothing with refreshes. * $params['routing'] = (any) Target the specified primary shard. * $params['stored_fields'] = (any) List of stored fields to return as part of a hit.If no fields are specified, no stored fields are included in the response.If this field is specified, the `_source` parameter defaults to false. * $params['version'] = (integer) Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. - * $params['version_type'] = (enum) Specific version type: internal, external, external_gte. (Options = external,external_gte,force,internal) + * $params['version_type'] = (enum) Specific version type: `internal`, `external`, `external_gte`. (Options = external,external_gte,force,internal) * $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) @@ -948,15 +955,15 @@ public function getScriptLanguages(array $params = []) * * $params['id'] = (string) Unique identifier of the document. (Required) * $params['index'] = (string) Name of the index that contains the document. (Required) - * $params['_source'] = (any) True or false to return the _source field or not, or a list of fields to return. + * $params['_source'] = (any) Set to `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. * $params['preference'] = (string) Specifies the node or shard the operation should be performed on. Random by default. (Default = random) - * $params['realtime'] = (boolean) Boolean) If true, the request is real-time as opposed to near-real-time. - * $params['refresh'] = (boolean) If true, OpenSearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + * $params['realtime'] = (boolean) Boolean) If `true`, the request is real-time as opposed to near-real-time. + * $params['refresh'] = (any) If `true`, OpenSearch refreshes the affected shards to make this operation visible to search. If `false`, do nothing with refreshes. * $params['routing'] = (any) Target the specified primary shard. * $params['version'] = (integer) Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. - * $params['version_type'] = (enum) Specific version type: internal, external, external_gte. (Options = external,external_gte,force,internal) + * $params['version_type'] = (enum) Specific version type. One of `internal`, `external`, `external_gte`. (Options = external,external_gte,force,internal) * $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) @@ -988,7 +995,7 @@ public function getSource(array $params = []) * $params['if_seq_no'] = (integer) Only perform the operation if the document has this sequence number. * $params['op_type'] = (enum) Set to create to only index the document if it does not already exist (put if absent).If a document with the specified `_id` already exists, the indexing operation will fail.Same as using the `/_create` endpoint.Valid values: `index`, `create`.If document id is specified, it defaults to `index`.Otherwise, it defaults to `create`. (Options = create,index) * $params['pipeline'] = (string) ID of the pipeline to use to preprocess incoming documents.If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.If a final pipeline is configured it will always run, regardless of the value of this parameter. - * $params['refresh'] = (enum) If `true`, OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.Valid values: `true`, `false`, `wait_for`. (Options = false,true,wait_for) + * $params['refresh'] = (any) If `true`, OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.Valid values: `true`, `false`, `wait_for`. * $params['require_alias'] = (boolean) If `true`, the destination must be an index alias. (Default = false) * $params['routing'] = (any) Custom value used to route operations to a specific shard. * $params['timeout'] = (string) Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. @@ -1044,12 +1051,12 @@ public function info(array $params = []) * Allows to get multiple documents in one request. * * $params['index'] = (string) Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index. - * $params['_source'] = (any) True or false to return the `_source` field or not, or a list of fields to return. + * $params['_source'] = (any) Set to `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 from the response.You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. * $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['preference'] = (string) Specifies the node or shard the operation should be performed on. Random by default. (Default = random) * $params['realtime'] = (boolean) If `true`, the request is real-time as opposed to near-real-time. - * $params['refresh'] = (boolean) If `true`, the request refreshes relevant shards before retrieving documents. + * $params['refresh'] = (any) If `true`, the request refreshes relevant shards before retrieving documents. * $params['routing'] = (any) Custom value used to route operations to a specific shard. * $params['stored_fields'] = (any) If `true`, retrieves the document fields stored in the index rather than the document `_source`. * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) @@ -1079,11 +1086,11 @@ public function mget(array $params = []) * Allows to execute several search operations in one request. * * $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['ccs_minimize_roundtrips'] = (boolean) If `true`, network round-trips 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) * $params['pre_filter_shard_size'] = (integer) Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint. - * $params['rest_total_hits_as_int'] = (boolean) If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. (Default = false) + * $params['rest_total_hits_as_int'] = (boolean) If `true`, `hits.total` are returned as an integer in the response. Defaults to false, which returns an object. (Default = false) * $params['search_type'] = (enum) Indicates whether global term and document frequencies should be used when scoring returned documents. (Options = dfs_query_then_fetch,query_then_fetch) * $params['typed_keys'] = (boolean) Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) @@ -1152,9 +1159,9 @@ public function msearchTemplate(array $params = []) * $params['payloads'] = (boolean) If `true`, the response includes term payloads. (Default = true) * $params['positions'] = (boolean) If `true`, the response includes term positions. (Default = true) * $params['preference'] = (string) Specifies the node or shard the operation should be performed on.Random by default. (Default = random) - * $params['realtime'] = (boolean) If true, the request is real-time as opposed to near-real-time. (Default = true) + * $params['realtime'] = (boolean) If `true`, the request is real-time as opposed to near-real-time. (Default = true) * $params['routing'] = (any) Custom value used to route operations to a specific shard. - * $params['term_statistics'] = (boolean) If true, the response includes term frequency and document frequency. (Default = false) + * $params['term_statistics'] = (boolean) If `true`, the response includes term frequency and document frequency. (Default = false) * $params['version'] = (integer) If `true`, returns the document version as part of a hit. * $params['version_type'] = (enum) Specific version type. (Options = external,external_gte,force,internal) * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) @@ -1209,7 +1216,7 @@ public function ping(array $params = []): bool * $params['id'] = (string) Identifier for the stored script or search template. Must be unique within the cluster. (Required) * $params['context'] = (string) Context in which the script or search template should run. To prevent errors, the API immediately compiles the script or template in this context. * $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['master_timeout'] = (string) Period to wait for a connection to the cluster-manager 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. * $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) @@ -1271,7 +1278,7 @@ public function rankEval(array $params = []) * Allows to copy documents from one index to another, optionally filtering the sourcedocuments by a query, changing the destination index settings, or fetching thedocuments from a remote cluster. * * $params['max_docs'] = (integer) Maximum number of documents to process. By default, all documents. - * $params['refresh'] = (boolean) If `true`, the request refreshes affected shards to make this operation visible to search. + * $params['refresh'] = (any) If `true`, the request refreshes affected shards to make this operation visible to search. * $params['requests_per_second'] = (number) The throttle for this request in sub-requests per second.Defaults to no throttle. (Default = 0) * $params['scroll'] = (string) Specifies how long a consistent view of the index should be maintained for scrolled search. * $params['slices'] = (any) The number of slices this task should be divided into.Defaults to 1 slice, meaning the task isn't sliced into subtasks. @@ -1333,7 +1340,7 @@ public function reindexRethrottle(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) The search definition template and its params + * $params['body'] = (array) The search definition template and its parameters. * * @param array $params Associative array of parameters * @return array @@ -1379,7 +1386,7 @@ public function scriptsPainlessExecute(array $params = []) * Allows to retrieve a large numbers of results from a single search request. * * $params['scroll_id'] = DEPRECATED (string) The scroll ID - * $params['rest_total_hits_as_int'] = (boolean) If true, the API response's hit.total property is returned as an integer. If false, the API response's hit.total property is returned as an object. (Default = false) + * $params['rest_total_hits_as_int'] = (boolean) If `true`, the API response's `hit.total` property is returned as an integer. If `false`, the API response's `hit.total` property is returned as an object. (Default = false) * $params['scroll'] = (string) Period to retain the search context for scrolling. * $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) @@ -1412,12 +1419,12 @@ public function scroll(array $params = []) * $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 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['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. * $params['batched_reduce_size'] = (integer) The number of shard results that should be reduced at once on the coordinating node.This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. (Default = 512) * $params['cancel_after_time_interval'] = (string) The time after which the search request will be canceled.Request-level parameter takes precedence over `cancel_after_time_interval` cluster setting. - * $params['ccs_minimize_roundtrips'] = (boolean) If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. (Default = true) + * $params['ccs_minimize_roundtrips'] = (boolean) If `true`, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. (Default = true) * $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['docvalue_fields'] = (any) A comma-separated list of fields to return as the docvalue representation for each hit. @@ -1426,7 +1433,7 @@ public function scroll(array $params = []) * $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 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['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. * $params['max_concurrent_shard_requests'] = (integer) Defines 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['phase_took'] = (boolean) Indicates whether to return phase-level `took` time values in the response. (Default = false) @@ -1519,7 +1526,7 @@ public function searchShards(array $params = []) * $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. - * $params['rest_total_hits_as_int'] = (boolean) If true, hits.total are rendered as an integer in the response. (Default = false) + * $params['rest_total_hits_as_int'] = (boolean) If `true`, `hits.total` are rendered as an integer in the response. (Default = false) * $params['routing'] = (any) Custom value used to route operations to a specific shard. * $params['scroll'] = (string) Specifies how long a consistent view of the indexshould be maintained for scrolled search. * $params['search_type'] = (enum) The type of the search operation. (Options = dfs_query_then_fetch,query_then_fetch) @@ -1529,7 +1536,7 @@ public function searchShards(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) The search definition template and its params (Required) + * $params['body'] = (array) The search definition template and its parameters. (Required) * * @param array $params Associative array of parameters * @return array @@ -1558,7 +1565,7 @@ public function searchTemplate(array $params = []) * $params['payloads'] = (boolean) If `true`, the response includes term payloads. (Default = true) * $params['positions'] = (boolean) If `true`, the response includes term positions. (Default = true) * $params['preference'] = (string) Specifies the node or shard the operation should be performed on.Random by default. (Default = random) - * $params['realtime'] = (boolean) If true, the request is real-time as opposed to near-real-time. (Default = true) + * $params['realtime'] = (boolean) If `true`, the request is real-time as opposed to near-real-time. (Default = true) * $params['routing'] = (any) Custom value used to route operations to a specific shard. * $params['term_statistics'] = (boolean) If `true`, the response includes term frequency and document frequency. (Default = false) * $params['version'] = (integer) If `true`, returns the document version as part of a hit. @@ -1593,14 +1600,14 @@ public function termvectors(array $params = []) * * $params['id'] = (string) Document ID (Required) * $params['index'] = (string) The name of the index (Required) - * $params['_source'] = (any) Set to false to disable source retrieval. You can also specify a comma-separatedlist of the fields you want to retrieve. + * $params['_source'] = (any) Set to `false` to disable source retrieval. You can also specify a comma-separatedlist of the fields you want to retrieve. * $params['_source_excludes'] = (any) Specify the source fields you want to exclude. * $params['_source_includes'] = (any) Specify the source fields you want to retrieve. * $params['if_primary_term'] = (integer) Only perform the operation if the document has this primary term. * $params['if_seq_no'] = (integer) Only perform the operation if the document has this sequence number. * $params['lang'] = (string) The script language. (Default = painless) - * $params['refresh'] = (enum) If 'true', OpenSearch refreshes the affected shards to make this operationvisible to search, if 'wait_for' then wait for a refresh to make this operationvisible to search, if 'false' do nothing with refreshes. (Options = false,true,wait_for) - * $params['require_alias'] = (boolean) If true, the destination must be an index alias. (Default = false) + * $params['refresh'] = (any) If 'true', OpenSearch refreshes the affected shards to make this operationvisible to search, if `wait_for` then wait for a refresh to make this operationvisible to search, if `false` do nothing with refreshes. + * $params['require_alias'] = (boolean) If `true`, the destination must be an index alias. (Default = false) * $params['retry_on_conflict'] = (integer) Specify how many times should the operation be retried when a conflict occurs. (Default = 0) * $params['routing'] = (any) Custom value used to route operations to a specific shard. * $params['timeout'] = (string) Period to wait for dynamic mapping updates and active shards.This guarantees OpenSearch waits for at least the timeout before failing.The actual wait time could be longer, particularly when multiple waits occur. @@ -1634,9 +1641,9 @@ 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, 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['_source'] = (array) Set to `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 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. @@ -1651,7 +1658,7 @@ public function update(array $params = []) * $params['pipeline'] = (string) ID of the pipeline to use to preprocess incoming documents.If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.If a final pipeline is configured it will always run, regardless of the value of this parameter. * $params['preference'] = (string) Specifies the node or shard the operation should be performed on.Random by default. (Default = random) * $params['q'] = (string) Query in the Lucene query string syntax. - * $params['refresh'] = (boolean) If `true`, OpenSearch refreshes affected shards to make the operation visible to search. + * $params['refresh'] = (any) If `true`, OpenSearch refreshes affected shards to make the operation visible to search. * $params['request_cache'] = (boolean) If `true`, the request cache is used for this request. * $params['requests_per_second'] = (number) The throttle for this request in sub-requests per second. (Default = 0) * $params['routing'] = (any) Custom value used to route operations to a specific shard. @@ -1659,7 +1666,7 @@ public function update(array $params = []) * $params['scroll_size'] = (integer) Size of the scroll request that powers the operation. (Default = 100) * $params['search_timeout'] = (string) Explicit timeout for each search request. * $params['search_type'] = (enum) The type of the search operation. Available options: `query_then_fetch`, `dfs_query_then_fetch`. (Options = dfs_query_then_fetch,query_then_fetch) - * $params['size'] = (integer) Deprecated, please use `max_docs` instead. + * $params['size'] = (integer) Deprecated, use `max_docs` instead. * $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. @@ -1917,6 +1924,13 @@ public function remoteStore(): RemoteStoreNamespace { return $this->remoteStore; } + /** + * Returns the replication namespace + */ + public function replication(): ReplicationNamespace + { + return $this->replication; + } /** * Returns the rollups namespace */ diff --git a/src/OpenSearch/Endpoints/Cat/Master.php b/src/OpenSearch/Endpoints/Cat/Master.php index 56961358..0f931a9c 100644 --- a/src/OpenSearch/Endpoints/Cat/Master.php +++ b/src/OpenSearch/Endpoints/Cat/Master.php @@ -27,7 +27,7 @@ * NOTE: This file is autogenerated using util/GenerateEndpoints.php */ /** - * @deprecated To promote inclusive language, please use '/_cat/cluster_manager' instead. + * @deprecated To promote inclusive language, use '/_cat/cluster_manager' instead. */ class Master extends AbstractEndpoint { diff --git a/src/OpenSearch/Endpoints/Replication/AutofollowStats.php b/src/OpenSearch/Endpoints/Replication/AutofollowStats.php new file mode 100644 index 00000000..26d842d4 --- /dev/null +++ b/src/OpenSearch/Endpoints/Replication/AutofollowStats.php @@ -0,0 +1,45 @@ +body = $body; + + return $this; + } +} diff --git a/src/OpenSearch/Endpoints/Replication/DeleteReplicationRule.php b/src/OpenSearch/Endpoints/Replication/DeleteReplicationRule.php new file mode 100644 index 00000000..5a0715af --- /dev/null +++ b/src/OpenSearch/Endpoints/Replication/DeleteReplicationRule.php @@ -0,0 +1,55 @@ +body = $body; + + return $this; + } +} diff --git a/src/OpenSearch/Endpoints/Replication/FollowerStats.php b/src/OpenSearch/Endpoints/Replication/FollowerStats.php new file mode 100644 index 00000000..34299dcd --- /dev/null +++ b/src/OpenSearch/Endpoints/Replication/FollowerStats.php @@ -0,0 +1,45 @@ +index ?? null; + if (isset($index)) { + return "/_plugins/_replication/$index/_pause"; + } + throw new RuntimeException('Missing parameter for the endpoint replication.pause'); + } + + public function getParamWhitelist(): array + { + return [ + 'pretty', + 'human', + 'error_trace', + 'source', + 'filter_path' + ]; + } + + public function getMethod(): string + { + return 'POST'; + } + + public function setBody($body): static + { + if (isset($body) !== true) { + return $this; + } + $this->body = $body; + + return $this; + } +} diff --git a/src/OpenSearch/Endpoints/Replication/Resume.php b/src/OpenSearch/Endpoints/Replication/Resume.php new file mode 100644 index 00000000..b8642f56 --- /dev/null +++ b/src/OpenSearch/Endpoints/Replication/Resume.php @@ -0,0 +1,60 @@ +index ?? null; + if (isset($index)) { + return "/_plugins/_replication/$index/_resume"; + } + throw new RuntimeException('Missing parameter for the endpoint replication.resume'); + } + + public function getParamWhitelist(): array + { + return [ + 'pretty', + 'human', + 'error_trace', + 'source', + 'filter_path' + ]; + } + + public function getMethod(): string + { + return 'POST'; + } + + public function setBody($body): static + { + if (isset($body) !== true) { + return $this; + } + $this->body = $body; + + return $this; + } +} diff --git a/src/OpenSearch/Endpoints/Replication/Start.php b/src/OpenSearch/Endpoints/Replication/Start.php new file mode 100644 index 00000000..d82c9294 --- /dev/null +++ b/src/OpenSearch/Endpoints/Replication/Start.php @@ -0,0 +1,60 @@ +index ?? null; + if (isset($index)) { + return "/_plugins/_replication/$index/_start"; + } + throw new RuntimeException('Missing parameter for the endpoint replication.start'); + } + + public function getParamWhitelist(): array + { + return [ + 'pretty', + 'human', + 'error_trace', + 'source', + 'filter_path' + ]; + } + + public function getMethod(): string + { + return 'PUT'; + } + + public function setBody($body): static + { + if (isset($body) !== true) { + return $this; + } + $this->body = $body; + + return $this; + } +} diff --git a/src/OpenSearch/Endpoints/Replication/Status.php b/src/OpenSearch/Endpoints/Replication/Status.php new file mode 100644 index 00000000..5a12a524 --- /dev/null +++ b/src/OpenSearch/Endpoints/Replication/Status.php @@ -0,0 +1,50 @@ +index ?? null; + if (isset($index)) { + return "/_plugins/_replication/$index/_status"; + } + throw new RuntimeException('Missing parameter for the endpoint replication.status'); + } + + public function getParamWhitelist(): array + { + return [ + 'pretty', + 'human', + 'error_trace', + 'source', + 'filter_path' + ]; + } + + public function getMethod(): string + { + return 'GET'; + } +} diff --git a/src/OpenSearch/Endpoints/Replication/Stop.php b/src/OpenSearch/Endpoints/Replication/Stop.php new file mode 100644 index 00000000..5e61624b --- /dev/null +++ b/src/OpenSearch/Endpoints/Replication/Stop.php @@ -0,0 +1,60 @@ +index ?? null; + if (isset($index)) { + return "/_plugins/_replication/$index/_stop"; + } + throw new RuntimeException('Missing parameter for the endpoint replication.stop'); + } + + public function getParamWhitelist(): array + { + return [ + 'pretty', + 'human', + 'error_trace', + 'source', + 'filter_path' + ]; + } + + public function getMethod(): string + { + return 'POST'; + } + + public function setBody($body): static + { + if (isset($body) !== true) { + return $this; + } + $this->body = $body; + + return $this; + } +} diff --git a/src/OpenSearch/Endpoints/Replication/UpdateSettings.php b/src/OpenSearch/Endpoints/Replication/UpdateSettings.php new file mode 100644 index 00000000..202e80d6 --- /dev/null +++ b/src/OpenSearch/Endpoints/Replication/UpdateSettings.php @@ -0,0 +1,60 @@ +index ?? null; + if (isset($index)) { + return "/_plugins/_replication/$index/_update"; + } + throw new RuntimeException('Missing parameter for the endpoint replication.update_settings'); + } + + public function getParamWhitelist(): array + { + return [ + 'pretty', + 'human', + 'error_trace', + 'source', + 'filter_path' + ]; + } + + public function getMethod(): string + { + return 'PUT'; + } + + public function setBody($body): static + { + if (isset($body) !== true) { + return $this; + } + $this->body = $body; + + return $this; + } +} diff --git a/src/OpenSearch/Namespaces/CatNamespace.php b/src/OpenSearch/Namespaces/CatNamespace.php index 71226012..28620544 100644 --- a/src/OpenSearch/Namespaces/CatNamespace.php +++ b/src/OpenSearch/Namespaces/CatNamespace.php @@ -35,7 +35,7 @@ class CatNamespace extends AbstractNamespace * * $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 indexes that are open, closed or both. - * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) @@ -65,7 +65,7 @@ public function aliases(array $params = []) * Lists all active point-in-time segments. * * $params['bytes'] = (enum) The unit in which to display byte values. (Options = b,g,gb,k,kb,m,mb,p,pb,t,tb) - * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. @@ -93,11 +93,11 @@ public function allPitSegments(array $params = []) * $params['node_id'] = (array) Comma-separated list of node identifiers or names used to limit the returned information. * $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. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) - * $params['master_timeout'] = (string) Operation timeout for connection to master node. + * $params['master_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) @@ -124,11 +124,11 @@ public function allocation(array $params = []) * Returns information about the cluster-manager node. * * $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. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) - * $params['master_timeout'] = (string) Operation timeout for connection to master node. + * $params['master_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) @@ -152,7 +152,7 @@ public function clusterManager(array $params = []) * Provides quick access to the document count of the entire cluster, or individual indexes. * * $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['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. @@ -178,11 +178,11 @@ public function count(array $params = []) } /** - * Shows how much heap memory is currently being used by fielddata on every data node in the cluster. + * Shows how much heap memory is currently being used by field data on every data node in the cluster. * * $params['fields'] = (array) Comma-separated list of fields used to limit returned information. To retrieve all fields, omit this parameter. * $params['bytes'] = (enum) The unit used to display byte values. (Options = b,g,gb,k,kb,m,mb,p,pb,t,tb) - * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. @@ -210,12 +210,12 @@ public function fielddata(array $params = []) /** * Returns a concise representation of the cluster health. * - * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. * $params['time'] = (enum) The unit used to display time values. (Options = d,h,m,micros,ms,nanos,s) - * $params['ts'] = (boolean) If true, returns `HH:MM:SS` and Unix epoch timestamps. (Default = true) + * $params['ts'] = (boolean) If `true`, returns `HH:MM:SS` and Unix epoch timestamps. (Default = true) * $params['v'] = (boolean) Verbose mode. Display column headers. (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) @@ -261,14 +261,14 @@ public function help(array $params = []) * $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['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['h'] = (array) Comma-separated list of column names to display. * $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['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) - * $params['master_timeout'] = (string) Operation timeout for connection to master node. - * $params['pri'] = (boolean) If true, the response only includes information from primary shards. (Default = false) + * $params['master_timeout'] = (string) Operation timeout for connection to cluster-manager node. + * $params['pri'] = (boolean) If `true`, the response only includes information from primary shards. (Default = false) * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. * $params['time'] = (enum) The unit used to display time values. (Options = d,h,m,micros,ms,nanos,s) * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) @@ -296,11 +296,11 @@ public function indices(array $params = []) * Returns information about the cluster-manager node. * * $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. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) - * $params['master_timeout'] = (string) Operation timeout for connection to master node. + * $params['master_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) @@ -324,11 +324,11 @@ public function master(array $params = []) * Returns information about custom node attributes. * * $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. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) - * $params['master_timeout'] = (string) Operation timeout for connection to master node. + * $params['master_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) @@ -353,12 +353,12 @@ public function nodeattrs(array $params = []) * * $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. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['full_id'] = (any) If `true`, return the full node ID. If `false`, return the shortened node ID. (Default = ) * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) - * $params['master_timeout'] = (string) Operation timeout for connection to master node. + * $params['master_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. * $params['time'] = (enum) The unit in which to display time values. (Options = d,h,m,micros,ms,nanos,s) * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) @@ -383,11 +383,11 @@ public function nodes(array $params = []) * Returns a concise representation of the cluster pending tasks. * * $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. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) - * $params['master_timeout'] = (string) Operation timeout for connection to master node. + * $params['master_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. * $params['time'] = (enum) The unit in which to display time values. (Options = d,h,m,micros,ms,nanos,s) * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) @@ -412,7 +412,7 @@ public function pendingTasks(array $params = []) * List segments for one or several PITs. * * $params['bytes'] = (enum) The unit in which to display byte values. (Options = b,g,gb,k,kb,m,mb,p,pb,t,tb) - * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. @@ -441,11 +441,11 @@ public function pitSegments(array $params = []) * Returns information about installed plugins across nodes node. * * $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. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) - * $params['master_timeout'] = (string) Operation timeout for connection to master node. + * $params['master_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) @@ -472,7 +472,7 @@ public function plugins(array $params = []) * $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) - * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. @@ -502,11 +502,11 @@ public function recovery(array $params = []) * Returns information about snapshot repositories registered in the cluster. * * $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. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) - * $params['master_timeout'] = (string) Operation timeout for connection to master node. + * $params['master_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) @@ -536,7 +536,7 @@ public function repositories(array $params = []) * $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 indexes that are open, closed or both. - * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. + * $params['format'] = (string) A short version of the Accept header (for example, `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 indexes should be ignored when throttled. @@ -572,10 +572,10 @@ public function segmentReplication(array $params = []) * $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. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) - * $params['master_timeout'] = (string) Operation timeout for connection to master node. + * $params['master_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) @@ -604,11 +604,11 @@ public function segments(array $params = []) * $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. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) - * $params['master_timeout'] = (string) Operation timeout for connection to master node. + * $params['master_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. * $params['time'] = (enum) The unit in which to display time values. (Options = d,h,m,micros,ms,nanos,s) * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) @@ -637,11 +637,11 @@ public function shards(array $params = []) * * $params['repository'] = (array) A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. If any repository fails during the request, OpenSearch returns an error. * $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. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) * $params['ignore_unavailable'] = (boolean) If `true`, the response does not include information from unavailable snapshots. (Default = false) - * $params['master_timeout'] = (string) Operation timeout for connection to master node. + * $params['master_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. * $params['time'] = (enum) The unit in which to display time values. (Options = d,h,m,micros,ms,nanos,s) * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) @@ -670,7 +670,7 @@ public function snapshots(array $params = []) * * $params['actions'] = (array) The task action names, which are used to limit the response. * $params['detailed'] = (boolean) If `true`, the response includes detailed information about shard recoveries. (Default = false) - * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. @@ -700,11 +700,11 @@ public function tasks(array $params = []) * * $params['name'] = (string) The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned. * $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. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) - * $params['master_timeout'] = (string) Operation timeout for connection to master node. + * $params['master_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) @@ -732,11 +732,11 @@ public function templates(array $params = []) * * $params['thread_pool_patterns'] = (array) A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions. * $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. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) - * $params['master_timeout'] = (string) Operation timeout for connection to master node. + * $params['master_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. * $params['size'] = (integer) The multiplier in which to display values. * $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) diff --git a/src/OpenSearch/Namespaces/ClusterNamespace.php b/src/OpenSearch/Namespaces/ClusterNamespace.php index a67c9878..363b5b2e 100644 --- a/src/OpenSearch/Namespaces/ClusterNamespace.php +++ b/src/OpenSearch/Namespaces/ClusterNamespace.php @@ -33,8 +33,8 @@ class ClusterNamespace extends AbstractNamespace /** * Provides explanations for shard allocations in the cluster. * - * $params['include_disk_info'] = (boolean) If true, returns information about disk usage and shard sizes. (Default = false) - * $params['include_yes_decisions'] = (boolean) If true, returns YES decisions in explanation. (Default = false) + * $params['include_disk_info'] = (boolean) If `true`, returns information about disk usage and shard sizes. (Default = false) + * $params['include_yes_decisions'] = (boolean) If `true`, returns YES decisions in explanation. (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) * $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) @@ -61,7 +61,7 @@ public function allocationExplain(array $params = []) * * $params['name'] = (string) Name of the component template to delete. Wildcard (*) expressions are supported. * $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['master_timeout'] = (string) Period to wait for a connection to the cluster-manager 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. * $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) @@ -106,7 +106,7 @@ public function deleteDecommissionAwareness(array $params = []) /** * Clears cluster voting config exclusions. * - * $params['wait_for_removal'] = (boolean) Specifies whether to wait for all excluded nodes to be removed from thecluster before clearing the voting configuration exclusions list.Defaults to true, meaning that all excluded nodes must be removed fromthe cluster before this API takes any action. If set to false then thevoting configuration exclusions list is cleared even if some excludednodes are still in the cluster. (Default = true) + * $params['wait_for_removal'] = (boolean) Specifies whether to wait for all excluded nodes to be removed from thecluster before clearing the voting configuration exclusions list.Defaults to true, meaning that all excluded nodes must be removed fromthe cluster before this API takes any action. If set to `false` then thevoting configuration exclusions list is cleared even if some excludednodes are still in the cluster. (Default = true) * $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) @@ -152,8 +152,8 @@ public function deleteWeightedRouting(array $params = []) * * $params['name'] = (string) Name of the component template to check existence of. Wildcard (*) expressions are supported. * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. - * $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 isreceived before the timeout expires, the request fails and returns anerror. + * $params['local'] = (boolean) If `true`, the request retrieves information from the local node only.Defaults to false, which means information is retrieved from the cluster-manager node. (Default = false) + * $params['master_timeout'] = (string) Period to wait for a connection to the cluster-manager node. If no response isreceived before the timeout expires, the request fails and returns anerror. * $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) @@ -182,8 +182,8 @@ public function existsComponentTemplate(array $params = []): bool * * $params['name'] = (array) Name of the component template to retrieve. Wildcard (`*`) expressions are supported. * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. - * $params['local'] = (boolean) If `true`, the request retrieves information from the local node only.If `false`, 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['local'] = (boolean) If `true`, the request retrieves information from the local node only.If `false`, information is retrieved from the cluster-manager node. (Default = false) + * $params['master_timeout'] = (string) Period to wait for a connection to the cluster-manager node.If no response is received before the timeout expires, the request fails and returns an error. * $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) @@ -234,7 +234,7 @@ public function getDecommissionAwareness(array $params = []) * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['flat_settings'] = (boolean) If `true`, returns settings in flat format. (Default = false) * $params['include_defaults'] = (boolean) If `true`, returns default cluster settings from the local 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['master_timeout'] = (string) Period to wait for a connection to the cluster-manager 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. * $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) @@ -285,13 +285,13 @@ public function getWeightedRouting(array $params = []) * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $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['local'] = (boolean) If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node. (Default = false) + * $params['master_timeout'] = (string) Period to wait for a connection to the cluster-manager 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. * $params['wait_for_active_shards'] = (any) A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait. * $params['wait_for_events'] = (enum) Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed. (Options = high,immediate,languid,low,normal,urgent) - * $params['wait_for_no_initializing_shards'] = (boolean) A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. - * $params['wait_for_no_relocating_shards'] = (boolean) A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. + * $params['wait_for_no_initializing_shards'] = (boolean) A Boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. + * $params['wait_for_no_relocating_shards'] = (boolean) A Boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. * $params['wait_for_nodes'] = (any) The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and yellow > red. By default, will not wait for any status. (Options = green,red,yellow) * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) @@ -318,8 +318,8 @@ public function health(array $params = []) * Returns a list of any cluster-level changes (e.g. create index, update mapping,allocate or fail shard) which have not yet been executed. * * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. - * $params['local'] = (boolean) If `true`, the request retrieves information from the local node only.If `false`, 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['local'] = (boolean) If `true`, the request retrieves information from the local node only.If `false`, information is retrieved from the cluster-manager node. (Default = false) + * $params['master_timeout'] = (string) Period to wait for a connection to the cluster-manager node.If no response is received before the timeout expires, the request fails and returns an error. * $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) @@ -340,8 +340,8 @@ public function pendingTasks(array $params = []) /** * Updates the cluster voting config exclusions by node ids or node names. * - * $params['node_ids'] = (any) A comma-separated list of the persistent ids of the nodes to excludefrom the voting configuration. If specified, you may not also specify node_names. - * $params['node_names'] = (any) A comma-separated list of the names of the nodes to exclude from thevoting configuration. If specified, you may not also specify node_ids. + * $params['node_ids'] = (any) A comma-separated list of the persistent ids of the nodes to excludefrom the voting configuration. If specified, you may not also specify `node_names`. + * $params['node_names'] = (any) A comma-separated list of the names of the nodes to exclude from thevoting configuration. If specified, you may not also specify `node_ids`. * $params['timeout'] = (string) When adding a voting configuration exclusion, the API waits for thespecified nodes to be excluded from the voting configuration beforereturning. If the timeout expires before the appropriate conditionis satisfied, the request fails and returns an error. * $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) @@ -366,7 +366,7 @@ public function postVotingConfigExclusions(array $params = []) * $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. + * $params['master_timeout'] = (string) Period to wait for a connection to the cluster-manager node.If no response is received before the timeout expires, the request fails and returns an error. * $params['timeout'] = (string) Operation timeout. * $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) @@ -423,7 +423,7 @@ public function putDecommissionAwareness(array $params = []) * * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['flat_settings'] = (boolean) Return settings in flat format. (Default = false) - * $params['master_timeout'] = (string) Explicit operation timeout for connection to master node + * $params['master_timeout'] = (string) Explicit operation timeout for connection to cluster-manager node * $params['timeout'] = (string) Explicit operation timeout * $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) @@ -496,11 +496,11 @@ public function remoteInfo(array $params = []) * Allows to manually change the allocation of individual shards in the cluster. * * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. - * $params['dry_run'] = (boolean) If true, then the request simulates the operation only and returns the resulting state. - * $params['explain'] = (boolean) If true, then the response contains an explanation of why the commands can or cannot be executed. - * $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['dry_run'] = (boolean) If `true`, then the request simulates the operation only and returns the resulting state. + * $params['explain'] = (boolean) If `true`, then the response contains an explanation of why the commands can or cannot be executed. + * $params['master_timeout'] = (string) Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. * $params['metric'] = (any) Limits the information returned to the specified metrics. - * $params['retry_failed'] = (boolean) If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures. + * $params['retry_failed'] = (boolean) If `true`, then retries allocation of shards that are blocked due to too many subsequent allocation failures. * $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. * $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) @@ -534,9 +534,9 @@ public function reroute(array $params = []) * $params['flat_settings'] = (boolean) Return settings in flat format. (Default = false) * $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 - * $params['wait_for_timeout'] = (string) The maximum time to wait for wait_for_metadata_version before timing out + * $params['master_timeout'] = (string) Specify timeout for connection to cluster manager. + * $params['wait_for_metadata_version'] = (integer) Wait for the metadata version to be equal or greater than the specified metadata version. + * $params['wait_for_timeout'] = (string) The maximum time to wait for `wait_for_metadata_version` before timing out. * $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) @@ -563,7 +563,7 @@ public function state(array $params = []) * Returns high-level overview of cluster statistics. * * $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['metric'] = (array) Limit the information returned to the specified metrics + * $params['metric'] = (array) Limit the information returned to the specified metrics. * $params['node_id'] = (array) Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster. * $params['flat_settings'] = (boolean) If `true`, returns settings in flat format. (Default = false) * $params['timeout'] = (string) Period to wait for each node to respond.If a node does not respond before its timeout expires, the response does not include its stats.However, timed out nodes are included in the response's `_nodes.failed` property. Defaults to no timeout. diff --git a/src/OpenSearch/Namespaces/DanglingIndicesNamespace.php b/src/OpenSearch/Namespaces/DanglingIndicesNamespace.php index fd1518db..14fd9acc 100644 --- a/src/OpenSearch/Namespaces/DanglingIndicesNamespace.php +++ b/src/OpenSearch/Namespaces/DanglingIndicesNamespace.php @@ -33,11 +33,11 @@ class DanglingIndicesNamespace extends AbstractNamespace /** * Deletes the specified dangling index. * - * $params['index_uuid'] = (string) The UUID of the dangling index - * $params['accept_data_loss'] = (boolean) Must be set to true in order to delete the dangling index + * $params['index_uuid'] = (string) The UUID of the dangling index. + * $params['accept_data_loss'] = (boolean) Must be set to true in order to delete the dangling index. * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. - * $params['master_timeout'] = (string) Specify timeout for connection to master - * $params['timeout'] = (string) Explicit operation timeout + * $params['master_timeout'] = (string) Specify timeout for connection to cluster manager. + * $params['timeout'] = (string) Explicit operation timeout. * $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) @@ -61,11 +61,11 @@ public function deleteDanglingIndex(array $params = []) /** * Imports the specified dangling index. * - * $params['index_uuid'] = (string) The UUID of the dangling index - * $params['accept_data_loss'] = (boolean) Must be set to true in order to import the dangling index + * $params['index_uuid'] = (string) The UUID of the dangling index. + * $params['accept_data_loss'] = (boolean) Must be set to true in order to import the dangling index. * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. - * $params['master_timeout'] = (string) Specify timeout for connection to master - * $params['timeout'] = (string) Explicit operation timeout + * $params['master_timeout'] = (string) Specify timeout for connection to cluster manager. + * $params['timeout'] = (string) Explicit operation timeout. * $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/FlowFrameworkNamespace.php b/src/OpenSearch/Namespaces/FlowFrameworkNamespace.php index 791f569c..d758ad9e 100644 --- a/src/OpenSearch/Namespaces/FlowFrameworkNamespace.php +++ b/src/OpenSearch/Namespaces/FlowFrameworkNamespace.php @@ -30,7 +30,7 @@ class FlowFrameworkNamespace extends AbstractNamespace * $params['provision'] = (boolean) (Default = false) * $params['reprovision'] = (boolean) (Default = false) * $params['update_fields'] = (boolean) (Default = false) - * $params['use_case'] = (string) To use a workflow template, specify it in the use_case query parameter when creating a workflow. + * $params['use_case'] = (string) To use a workflow template, specify it in the `use_case` query parameter when creating a workflow. * $params['validation'] = (string) (Default = all) * $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) @@ -251,7 +251,7 @@ public function searchState(array $params = []) * $params['provision'] = (boolean) (Default = false) * $params['reprovision'] = (boolean) (Default = false) * $params['update_fields'] = (boolean) (Default = false) - * $params['use_case'] = (string) To use a workflow template, specify it in the use_case query parameter when creating a workflow. + * $params['use_case'] = (string) To use a workflow template, specify it in the `use_case` query parameter when creating a workflow. * $params['validation'] = (string) (Default = all) * $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 568359c5..7106a8c7 100644 --- a/src/OpenSearch/Namespaces/IndicesNamespace.php +++ b/src/OpenSearch/Namespaces/IndicesNamespace.php @@ -33,13 +33,13 @@ 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 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['block'] = (string) The block to add (one of `read`, `write`, `read_only` or `metadata`). + * $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 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['ignore_unavailable'] = (boolean) Whether specified concrete indexes should be ignored when unavailable (missing or closed). + * $params['master_timeout'] = (string) Specify timeout for connection to cluster manager. * $params['timeout'] = (string) Explicit operation timeout * $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) @@ -98,7 +98,7 @@ public function analyze(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`.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. - * $params['file'] = (boolean) If true, clears the unused entries from the file cache on nodes with the Search role. (Default = false) + * $params['file'] = (boolean) If `true`, clears the unused entries from the file cache on nodes with the Search role. (Default = false) * $params['ignore_unavailable'] = (boolean) If `false`, the request returns an error if it targets a missing or closed index. * $params['query'] = (boolean) If `true`, clears the query cache. * $params['request'] = (boolean) If `true`, clears the request cache. @@ -128,8 +128,8 @@ public function clearCache(array $params = []) * $params['index'] = (string) Name of the source index to clone. * $params['target'] = (string) Name of the target index to create. * $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['task_execution_timeout'] = (string) Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + * $params['master_timeout'] = (string) Period to wait for a connection to the cluster-manager node.If no response is received before the timeout expires, the request fails and returns an error. + * $params['task_execution_timeout'] = (string) Explicit task execution timeout, only useful when `wait_for_completion` is false, defaults to `1h`. * $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. * $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`). * $params['wait_for_completion'] = (boolean) Should this request wait until the operation has completed before returning. (Default = true) @@ -166,7 +166,7 @@ public function clone(array $params = []) * $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. - * $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['master_timeout'] = (string) Period to wait for a connection to the cluster-manager 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. * $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`). * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) @@ -194,7 +194,7 @@ public function close(array $params = []) * * $params['index'] = (string) Name of the index you wish to create. * $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['master_timeout'] = (string) Period to wait for a connection to the cluster-manager 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. * $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`). * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) @@ -279,7 +279,7 @@ public function dataStreamsStats(array $params = []) * $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) - * $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['master_timeout'] = (string) Period to wait for a connection to the cluster-manager 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. * $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) @@ -307,7 +307,7 @@ public function delete(array $params = []) * $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. + * $params['master_timeout'] = (string) Period to wait for a connection to the cluster-manager 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. * $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) @@ -360,7 +360,7 @@ public function deleteDataStream(array $params = []) * * $params['name'] = (string) Name of the index template to delete. Wildcard (*) expressions are supported. * $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['master_timeout'] = (string) Period to wait for a connection to the cluster-manager 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. * $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) @@ -387,7 +387,7 @@ public function deleteIndexTemplate(array $params = []) * * $params['name'] = (string) The name of the legacy index template to delete. Wildcard (`*`) expressions are supported. * $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['master_timeout'] = (string) Period to wait for a connection to the cluster-manager 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. * $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) @@ -484,7 +484,7 @@ public function existsAlias(array $params = []): bool * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['flat_settings'] = (boolean) Return settings in flat format. (Default = false) * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager 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['master_timeout'] = (string) Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. * $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) @@ -515,7 +515,7 @@ public function existsIndexTemplate(array $params = []): bool * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['flat_settings'] = (boolean) Return settings in flat format. (Default = false) * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) - * $params['master_timeout'] = (string) Explicit operation timeout for connection to master node + * $params['master_timeout'] = (string) Explicit operation timeout for connection to cluster-manager node * $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) @@ -604,14 +604,14 @@ public function forcemerge(array $params = []) * Returns information about one or more indexes. * * $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['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) - * $params['ignore_unavailable'] = (boolean) If false, requests that target a missing index return an error. (Default = false) - * $params['include_defaults'] = (boolean) If true, return all default settings in the response. (Default = false) - * $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['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) + * $params['ignore_unavailable'] = (boolean) If `false`, requests that target a missing index return an error. (Default = false) + * $params['include_defaults'] = (boolean) If `true`, return all default settings in the response. (Default = false) + * $params['local'] = (boolean) If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node. (Default = false) + * $params['master_timeout'] = (string) Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. * $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) @@ -724,9 +724,9 @@ public function getFieldMapping(array $params = []) * * $params['name'] = (array) Name of the index template to retrieve. Wildcard (*) expressions are supported. * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. - * $params['flat_settings'] = (boolean) If true, returns settings in flat format. (Default = false) - * $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['flat_settings'] = (boolean) If `true`, returns settings in flat format. (Default = false) + * $params['local'] = (boolean) If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node. (Default = false) + * $params['master_timeout'] = (string) Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. * $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) @@ -756,7 +756,7 @@ public function getIndexTemplate(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`.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) - * $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['master_timeout'] = (string) Period to wait for a connection to the cluster-manager node.If no response is received before the timeout expires, the request fails and returns an error. * $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) @@ -788,8 +788,8 @@ public function getMapping(array $params = []) * $params['flat_settings'] = (boolean) If `true`, returns settings in flat format. (Default = false) * $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. (Default = false) - * $params['local'] = (boolean) If `true`, the request retrieves information from the local node only. If`false`, 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 isreceived before the timeout expires, the request fails and returns anerror. + * $params['local'] = (boolean) If `true`, the request retrieves information from the local node only. If`false`, information is retrieved from the cluster-manager node. (Default = false) + * $params['master_timeout'] = (string) Period to wait for a connection to the cluster-manager node. If no response isreceived before the timeout expires, the request fails and returns anerror. * $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) @@ -819,7 +819,7 @@ public function getSettings(array $params = []) * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['flat_settings'] = (boolean) If `true`, returns settings in flat format. (Default = false) * $params['local'] = (boolean) If `true`, the request retrieves information from the local node only. (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['master_timeout'] = (string) Period to wait for a connection to the cluster-manager node.If no response is received before the timeout expires, the request fails and returns an error. * $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) @@ -841,7 +841,7 @@ public function getTemplate(array $params = []) } /** - * The _upgrade API is no longer useful and will be removed. + * The `_upgrade` API is no longer useful and will be removed. * * $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). @@ -875,8 +875,8 @@ public function getUpgrade(array $params = []) * $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. - * $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['task_execution_timeout'] = (string) Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + * $params['master_timeout'] = (string) Period to wait for a connection to the cluster-manager node.If no response is received before the timeout expires, the request fails and returns an error. + * $params['task_execution_timeout'] = (string) Explicit task execution timeout, only useful when `wait_for_completion` is false, defaults to `1h`. * $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. * $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`). * $params['wait_for_completion'] = (boolean) Should this request wait until the operation has completed before returning. (Default = true) @@ -906,7 +906,7 @@ public function open(array $params = []) * $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 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['master_timeout'] = (string) Period to wait for a connection to the cluster-manager 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. * $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) @@ -940,7 +940,7 @@ public function putAlias(array $params = []) * $params['cause'] = (string) User defined reason for creating/updating the index template. (Default = false) * $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 index templates. (Default = false) - * $params['master_timeout'] = (string) Operation timeout for connection to master node. + * $params['master_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $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) @@ -972,7 +972,7 @@ public function putIndexTemplate(array $params = []) * $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. - * $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['master_timeout'] = (string) Period to wait for a connection to the cluster-manager 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. * $params['write_index_only'] = (boolean) If `true`, the mappings are applied only to the current write index for the target. (Default = false) * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) @@ -1007,7 +1007,7 @@ public function putMapping(array $params = []) * $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 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['master_timeout'] = (string) Period to wait for a connection to the cluster-manager 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. * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) @@ -1037,8 +1037,8 @@ public function putSettings(array $params = []) * * $params['name'] = (string) The name of the template * $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 index templates. (Default = false) - * $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 an error. + * $params['create'] = (boolean) If `true`, this request cannot replace or update existing index templates. (Default = false) + * $params['master_timeout'] = (string) Period to wait for a connection to the cluster-manager node. If no response isreceived before the timeout expires, the request fails and returns an error. * $params['order'] = (number) Order in which OpenSearch applies this template if indexmatches multiple templates.Templates with lower 'order' values are merged first. Templates with higher'order' values are merged later, overriding templates with lower values. * $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) @@ -1148,7 +1148,7 @@ public function resolveIndex(array $params = []) * $params['new_index'] = (string) Name of the index to create. Supports date math. Data streams do not support this parameter. * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['dry_run'] = (boolean) If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover. (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['master_timeout'] = (string) Period to wait for a connection to the cluster-manager 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. * $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`). * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) @@ -1208,9 +1208,9 @@ public function segments(array $params = []) * Provides store information for shard copies of indexes. * * $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['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 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 indexes 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) @@ -1239,8 +1239,8 @@ public function shardStores(array $params = []) * $params['target'] = (string) Name of the target index to create. * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['copy_settings'] = (boolean) whether or not to copy settings from the source index. (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['task_execution_timeout'] = (string) Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + * $params['master_timeout'] = (string) Period to wait for a connection to the cluster-manager node.If no response is received before the timeout expires, the request fails and returns an error. + * $params['task_execution_timeout'] = (string) Explicit task execution timeout, only useful when `wait_for_completion` is false, defaults to `1h`. * $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. * $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`). * $params['wait_for_completion'] = (boolean) Should this request wait until the operation has completed before returning. (Default = true) @@ -1276,7 +1276,7 @@ public function shrink(array $params = []) * $params['cause'] = (string) User defined reason for dry-run creating the new template for simulation purposes. (Default = false) * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['create'] = (boolean) If `true`, the template passed in the body is only used if no existingtemplates match the same index patterns. If `false`, the simulation usesthe template with the highest priority. Note that the template is notpermanently added or updated in either case; it is only used for thesimulation. (Default = false) - * $params['master_timeout'] = (string) Period to wait for a connection to the master node. If no response is receivedbefore the timeout expires, the request fails and returns an error. + * $params['master_timeout'] = (string) Period to wait for a connection to the cluster-manager node. If no response is receivedbefore the timeout expires, the request fails and returns an error. * $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) @@ -1306,8 +1306,8 @@ public function simulateIndexTemplate(array $params = []) * $params['name'] = (string) Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template configuration in the request body. * $params['cause'] = (string) User defined reason for dry-run creating the new template for simulation purposes. (Default = false) * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. - * $params['create'] = (boolean) If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. (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['create'] = (boolean) If `true`, the template passed in the body is only used if no existing templates match the same index patterns. If `false`, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. (Default = false) + * $params['master_timeout'] = (string) Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. * $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) @@ -1337,8 +1337,8 @@ public function simulateTemplate(array $params = []) * $params['target'] = (string) Name of the target index to create. * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['copy_settings'] = (boolean) whether or not to copy settings from the source index. (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['task_execution_timeout'] = (string) Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + * $params['master_timeout'] = (string) Period to wait for a connection to the cluster-manager node.If no response is received before the timeout expires, the request fails and returns an error. + * $params['task_execution_timeout'] = (string) Explicit task execution timeout, only useful when `wait_for_completion` is false, defaults to `1h`. * $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. * $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`). * $params['wait_for_completion'] = (boolean) Should this request wait until the operation has completed before returning. (Default = true) @@ -1372,14 +1372,14 @@ public function split(array $params = []) * * $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 indexes - * $params['completion_fields'] = (any) Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + * $params['completion_fields'] = (any) Comma-separated list or wildcard expressions of fields to include in field data 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['fielddata_fields'] = (any) Comma-separated list or wildcard expressions of fields to include in field data 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 indexes. (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) + * $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) * $params['level'] = (enum) Indicates whether statistics are aggregated at the cluster, index, or shard level. (Options = cluster,indices,shards) * $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) @@ -1407,7 +1407,7 @@ public function stats(array $params = []) * Updates index aliases. * * $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['master_timeout'] = (string) Period to wait for a connection to the cluster-manager 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. * $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) @@ -1431,13 +1431,13 @@ public function updateAliases(array $params = []) } /** - * The _upgrade API is no longer useful and will be removed. + * The `_upgrade` API is no longer useful and will be removed. * * $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['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) * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) diff --git a/src/OpenSearch/Namespaces/IngestNamespace.php b/src/OpenSearch/Namespaces/IngestNamespace.php index 7e8d4c04..717ef567 100644 --- a/src/OpenSearch/Namespaces/IngestNamespace.php +++ b/src/OpenSearch/Namespaces/IngestNamespace.php @@ -35,7 +35,7 @@ class IngestNamespace extends AbstractNamespace * * $params['id'] = (string) Pipeline ID or wildcard expression of pipeline IDs used to limit the request. To delete all ingest pipelines in a cluster, use a value of `*`. * $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['master_timeout'] = (string) Period to wait for a connection to the cluster-manager 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. * $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) @@ -62,7 +62,7 @@ public function deletePipeline(array $params = []) * * $params['id'] = (string) Comma-separated list of pipeline IDs to retrieve. Wildcard (`*`) expressions are supported. To get all ingest pipelines, omit this parameter or use `*`. * $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['master_timeout'] = (string) Period to wait for a connection to the cluster-manager node.If no response is received before the timeout expires, the request fails and returns an error. * $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) @@ -108,7 +108,7 @@ public function processorGrok(array $params = []) * * $params['id'] = (string) ID of the ingest pipeline to create or update. * $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['master_timeout'] = (string) Period to wait for a connection to the cluster-manager 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. * $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/IsmNamespace.php b/src/OpenSearch/Namespaces/IsmNamespace.php index 0984716f..bebc3911 100644 --- a/src/OpenSearch/Namespaces/IsmNamespace.php +++ b/src/OpenSearch/Namespaces/IsmNamespace.php @@ -128,7 +128,7 @@ public function existsPolicy(array $params = []): bool } /** - * Gets the currently applied policy on indices. + * Gets the currently applied policy on indexes. * * $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) diff --git a/src/OpenSearch/Namespaces/KnnNamespace.php b/src/OpenSearch/Namespaces/KnnNamespace.php index d13fa243..0fb72f78 100644 --- a/src/OpenSearch/Namespaces/KnnNamespace.php +++ b/src/OpenSearch/Namespaces/KnnNamespace.php @@ -75,9 +75,9 @@ public function getModel(array $params = []) /** * Use an OpenSearch query to search for models in the index. * - * $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['_source'] = (array) Set to `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 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) @@ -94,11 +94,11 @@ public function getModel(array $params = []) * $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. + * $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, that is if date filters are mandatory to match but the shard bounds and the query are disjoint. * $params['preference'] = (string) Specify the node or shard the operation should be performed on. (Default = random) * $params['q'] = (string) Query in the Lucene query string syntax. * $params['request_cache'] = (boolean) Specify if request cache should be used for this request or not, defaults to index level setting. - * $params['rest_total_hits_as_int'] = (boolean) Indicates whether hits.total should be rendered as an integer or an object in the rest search response. (Default = false) + * $params['rest_total_hits_as_int'] = (boolean) Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. (Default = false) * $params['routing'] = (any) Comma-separated list of specific routing values. * $params['scroll'] = (string) Specify how long a consistent view of the index should be maintained for scrolled search. * $params['search_type'] = (enum) Search operation type. (Options = dfs_query_then_fetch,query_then_fetch) diff --git a/src/OpenSearch/Namespaces/ListNamespace.php b/src/OpenSearch/Namespaces/ListNamespace.php index 973e0da3..171c287d 100644 --- a/src/OpenSearch/Namespaces/ListNamespace.php +++ b/src/OpenSearch/Namespaces/ListNamespace.php @@ -55,11 +55,11 @@ public function help(array $params = []) * $params['h'] = (array) Comma-separated list of column names to display. * $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['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) - * $params['master_timeout'] = (string) Operation timeout for connection to cluster manager node. + * $params['master_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['next_token'] = (Array) Token to retrieve next page of indexes. - * $params['pri'] = (boolean) If true, the response only includes information from primary shards. (Default = false) + * $params['pri'] = (boolean) If `true`, the response only includes information from primary shards. (Default = false) * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. * $params['size'] = (integer) Maximum number of indexes to be displayed in a page. * $params['sort'] = (enum) Defines order in which indexes will be displayed. Accepted values are `asc` and `desc`. If `desc`, most recently created indexes would be displayed first. (Options = asc,desc) @@ -95,7 +95,7 @@ public function indices(array $params = []) * $params['h'] = (array) Comma-separated list of column names to display. * $params['help'] = (boolean) Return help information. (Default = false) * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) - * $params['master_timeout'] = (string) Operation timeout for connection to cluster manager node. + * $params['master_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['next_token'] = (Array) Token to retrieve next page of shards. * $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. * $params['size'] = (integer) Maximum number of shards to be displayed in a page. diff --git a/src/OpenSearch/Namespaces/NodesNamespace.php b/src/OpenSearch/Namespaces/NodesNamespace.php index 069f6d36..d5029067 100644 --- a/src/OpenSearch/Namespaces/NodesNamespace.php +++ b/src/OpenSearch/Namespaces/NodesNamespace.php @@ -36,7 +36,7 @@ class NodesNamespace extends AbstractNamespace * $params['node_id'] = (array) Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. * $params['ignore_idle_threads'] = (boolean) Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue. (Default = true) * $params['interval'] = (string) The interval for the second sampling of threads. - * $params['snapshots'] = (integer) Number of samples of thread stacktrace. (Default = 10) + * $params['snapshots'] = (integer) Number of samples of thread stack trace. (Default = 10) * $params['threads'] = (integer) Specify the number of threads to provide information for. (Default = 3) * $params['timeout'] = (string) Operation timeout. * $params['type'] = (enum) The type to sample. (Options = block,cpu,wait) @@ -63,10 +63,10 @@ public function hotThreads(array $params = []) /** * Returns information about nodes in the cluster. * - * $params['node_id_or_metric'] = (any) Limits the information returned to a list of node IDs or specific metrics. Supports a comma-separated list, such as node1,node2 or http,ingest. + * $params['node_id_or_metric'] = (any) Limits the information returned to a list of node IDs or specific metrics. Supports a comma-separated list, such as `node1,node2` or `http,ingest`. * $params['metric'] = (array) Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest. * $params['node_id'] = (array) Comma-separated list of node IDs or names used to limit returned information. - * $params['flat_settings'] = (boolean) If true, returns settings in flat format. (Default = false) + * $params['flat_settings'] = (boolean) If `true`, returns settings in flat format. (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. * $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) @@ -102,7 +102,7 @@ public function info(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) An object containing the password for the opensearch keystore + * $params['body'] = (array) An object containing the password for the OpenSearch keystore. * * @param array $params Associative array of parameters * @return array @@ -126,11 +126,11 @@ 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 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['completion_fields'] = (any) Comma-separated list or wildcard expressions of fields to include in field data and suggest statistics. + * $params['fielddata_fields'] = (any) Comma-separated list or wildcard expressions of fields to include in field data statistics. * $params['fields'] = (any) Comma-separated list or wildcard expressions of fields to include in the statistics. * $params['groups'] = (array) 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_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['level'] = (enum) Indicates whether statistics are aggregated at the cluster, index, or shard level. (Options = cluster,indices,shards) * $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. * $params['types'] = (array) A comma-separated list of document types for the indexing index metric. diff --git a/src/OpenSearch/Namespaces/PplNamespace.php b/src/OpenSearch/Namespaces/PplNamespace.php index 863e8281..aa08509a 100644 --- a/src/OpenSearch/Namespaces/PplNamespace.php +++ b/src/OpenSearch/Namespaces/PplNamespace.php @@ -27,7 +27,7 @@ class PplNamespace extends AbstractNamespace /** * Shows how a query is executed against OpenSearch. * - * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['sanitize'] = (boolean) Specifies whether to escape special characters in the results. (Default = true) * $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) @@ -52,7 +52,7 @@ public function explain(array $params = []) /** * Collect metrics for the plugin within the interval. * - * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['sanitize'] = (boolean) Specifies whether to escape special characters in the results. (Default = true) * $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) @@ -74,7 +74,7 @@ public function getStats(array $params = []) /** * By a stats endpoint, you are able to collect metrics for the plugin within the interval. * - * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['sanitize'] = (boolean) Specifies whether to escape special characters in the results. (Default = true) * $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) @@ -99,7 +99,7 @@ public function postStats(array $params = []) /** * Send a PPL query to the PPL plugin. * - * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['sanitize'] = (boolean) Specifies whether to escape special characters in the results. (Default = true) * $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/ReplicationNamespace.php b/src/OpenSearch/Namespaces/ReplicationNamespace.php new file mode 100644 index 00000000..e90c397d --- /dev/null +++ b/src/OpenSearch/Namespaces/ReplicationNamespace.php @@ -0,0 +1,287 @@ +endpointFactory->getEndpoint(\OpenSearch\Endpoints\Replication\AutofollowStats::class); + $endpoint->setParams($params); + + return $this->performRequest($endpoint); + } + + /** + * Automatically starts replication on indexes matching a specified pattern. + * + * $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) + * $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 "-". + * + * @param array $params Associative array of parameters + * @return array + */ + public function createReplicationRule(array $params = []) + { + $body = $this->extractArgument($params, 'body'); + + $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Replication\CreateReplicationRule::class); + $endpoint->setParams($params); + $endpoint->setBody($body); + + return $this->performRequest($endpoint); + } + + /** + * Deletes the specified replication rule. + * + * $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) + * $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 "-". + * + * @param array $params Associative array of parameters + * @return array + */ + public function deleteReplicationRule(array $params = []) + { + $body = $this->extractArgument($params, 'body'); + + $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Replication\DeleteReplicationRule::class); + $endpoint->setParams($params); + $endpoint->setBody($body); + + return $this->performRequest($endpoint); + } + + /** + * Gets information about follower (syncing) indexes on a specified cluster. + * + * $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) + * $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 "-". + * + * @param array $params Associative array of parameters + * @return array + */ + public function followerStats(array $params = []) + { + $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Replication\FollowerStats::class); + $endpoint->setParams($params); + + return $this->performRequest($endpoint); + } + + /** + * Gets information about replicated leader indexes on a specified cluster. + * + * $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) + * $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 "-". + * + * @param array $params Associative array of parameters + * @return array + */ + public function leaderStats(array $params = []) + { + $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Replication\LeaderStats::class); + $endpoint->setParams($params); + + return $this->performRequest($endpoint); + } + + /** + * Pauses replication of the leader index. + * + * $params['index'] = (string) Name of the data stream, index, or index alias to perform bulk actions on. + * $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) + * $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 "-". + * + * @param array $params Associative array of parameters + * @return array + */ + public function pause(array $params = []) + { + $index = $this->extractArgument($params, 'index'); + $body = $this->extractArgument($params, 'body'); + + $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Replication\Pause::class); + $endpoint->setParams($params); + $endpoint->setIndex($index); + $endpoint->setBody($body); + + return $this->performRequest($endpoint); + } + + /** + * Resumes replication of the leader index. + * + * $params['index'] = (string) Name of the data stream, index, or index alias to perform bulk actions on. + * $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) + * $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 "-". + * + * @param array $params Associative array of parameters + * @return array + */ + public function resume(array $params = []) + { + $index = $this->extractArgument($params, 'index'); + $body = $this->extractArgument($params, 'body'); + + $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Replication\Resume::class); + $endpoint->setParams($params); + $endpoint->setIndex($index); + $endpoint->setBody($body); + + return $this->performRequest($endpoint); + } + + /** + * Initiate replication of an index from the leader cluster to the follower cluster. + * + * $params['index'] = (string) Name of the data stream, index, or index alias to perform bulk actions on. + * $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) + * $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 "-". + * + * @param array $params Associative array of parameters + * @return array + */ + public function start(array $params = []) + { + $index = $this->extractArgument($params, 'index'); + $body = $this->extractArgument($params, 'body'); + + $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Replication\Start::class); + $endpoint->setParams($params); + $endpoint->setIndex($index); + $endpoint->setBody($body); + + return $this->performRequest($endpoint); + } + + /** + * Gets the status of index replication. + * + * $params['index'] = (string) Name of the data stream, index, or index alias to perform bulk actions on. + * $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) + * $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 "-". + * + * @param array $params Associative array of parameters + * @return array + */ + public function status(array $params = []) + { + $index = $this->extractArgument($params, 'index'); + + $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Replication\Status::class); + $endpoint->setParams($params); + $endpoint->setIndex($index); + + return $this->performRequest($endpoint); + } + + /** + * Terminates replication and converts the follower index to a standard index. + * + * $params['index'] = (string) Name of the data stream, index, or index alias to perform bulk actions on. + * $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) + * $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 "-". + * + * @param array $params Associative array of parameters + * @return array + */ + public function stop(array $params = []) + { + $index = $this->extractArgument($params, 'index'); + $body = $this->extractArgument($params, 'body'); + + $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Replication\Stop::class); + $endpoint->setParams($params); + $endpoint->setIndex($index); + $endpoint->setBody($body); + + return $this->performRequest($endpoint); + } + + /** + * Updates settings on the follower index. + * + * $params['index'] = (string) Name of the data stream, index, or index alias to perform bulk actions on. + * $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) + * $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 "-". + * + * @param array $params Associative array of parameters + * @return array + */ + public function updateSettings(array $params = []) + { + $index = $this->extractArgument($params, 'index'); + $body = $this->extractArgument($params, 'body'); + + $endpoint = $this->endpointFactory->getEndpoint(\OpenSearch\Endpoints\Replication\UpdateSettings::class); + $endpoint->setParams($params); + $endpoint->setIndex($index); + $endpoint->setBody($body); + + return $this->performRequest($endpoint); + } + +} diff --git a/src/OpenSearch/Namespaces/SecurityNamespace.php b/src/OpenSearch/Namespaces/SecurityNamespace.php index 67134603..7930ef90 100644 --- a/src/OpenSearch/Namespaces/SecurityNamespace.php +++ b/src/OpenSearch/Namespaces/SecurityNamespace.php @@ -437,7 +437,7 @@ public function generateUserToken(array $params = []) } /** - * Generates authorization token for the given user. Legacy API. Not Implemented. + * Generates authorization token for the given user. Legacy API. Not Implemented. * * $params['username'] = (string) The name of the user for whom an auth token is to be vended. (Required) * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) @@ -630,7 +630,7 @@ public function getDashboardsInfo(array $params = []) * Retrieves distinguished names. Only accessible to super-admins and with rest-api permissions when enabled. * * $params['cluster_name'] = (string) The cluster-name to retrieve nodes DN setting for. (Required) - * $params['show_all'] = (boolean) A boolean flag to include/exclude static nodes DN from final result. + * $params['show_all'] = (boolean) A Boolean flag to include/exclude static nodes DN from final result. * $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) @@ -748,7 +748,7 @@ public function getRoleMapping(array $params = []) /** * Retrieves the SSL configuration information. * - * $params['show_dn'] = (Array) A boolean flag to indicate whether all domain names should be returned. + * $params['show_dn'] = (Array) A Boolean flag to indicate whether all domain names should be returned. * $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) @@ -881,7 +881,7 @@ public function getUsersLegacy(array $params = []) /** * Checks to see if the Security plugin is up and running. * - * $params['mode'] = (string) A flag to indicate whether service should consider security-plugin's status before returning health response. `strict` mode indicates service should check security plugin status. + * $params['mode'] = (string) A flag to indicate whether service should consider security-plugin's status before returning health response. `strict` mode indicates service should check Security plugin status. * $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) @@ -992,7 +992,7 @@ public function patchAuditConfiguration(array $params = []) } /** - * A PATCH call is used to update the existing configuration using the REST API. Only accessible by admins and users with rest api access and only when put or patch is enabled. + * A `PATCH` call is used to update the existing configuration using the REST API. Only accessible by admins and users with REST API access and only when put or patch is enabled. * * $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) @@ -1017,7 +1017,7 @@ public function patchConfiguration(array $params = []) /** * Updates a distinguished cluster name for a specific cluster. Only accessible to super-admins and with rest-api permissions when enabled. * - * $params['cluster_name'] = (string) The cluster-name to update nodesDn value. (Required) + * $params['cluster_name'] = (string) The cluster name to update `nodesDn` value. (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) @@ -1271,7 +1271,7 @@ public function updateAuditConfiguration(array $params = []) } /** - * Adds or updates the existing configuration using the REST API. Only accessible by admins and users with rest api access and only when put or patch is enabled. + * Adds or updates the existing configuration using the REST API. Only accessible by admins and users with REST API access and only when put or patch is enabled. * * $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) @@ -1296,7 +1296,7 @@ public function updateConfiguration(array $params = []) /** * Adds or updates the specified distinguished names in the cluster or node allow list. Only accessible to super-admins and with rest-api permissions when enabled. * - * $params['cluster_name'] = (string) The cluster-name to create/update nodesDn value for. (Required) + * $params['cluster_name'] = (string) The cluster-name to create/update `nodesDn` value for. (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) @@ -1322,7 +1322,7 @@ public function updateDistinguishedName(array $params = []) /** * Checks whether the v6 security configuration is valid and ready to be migrated to v7. * - * $params['accept_invalid'] = (boolean) A boolean flag to indicate whether invalid v6 configuration should be allowed. + * $params['accept_invalid'] = (boolean) A Boolean flag to indicate whether invalid v6 configuration should be allowed. * $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/SnapshotNamespace.php b/src/OpenSearch/Namespaces/SnapshotNamespace.php index 0adc41e5..b93cb40d 100644 --- a/src/OpenSearch/Namespaces/SnapshotNamespace.php +++ b/src/OpenSearch/Namespaces/SnapshotNamespace.php @@ -35,7 +35,7 @@ class SnapshotNamespace extends AbstractNamespace * * $params['repository'] = (string) Snapshot repository to clean up. * $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. + * $params['master_timeout'] = (string) Period to wait for a connection to the cluster-manager node. * $params['timeout'] = (string) Period to wait for a response. * $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) @@ -64,7 +64,7 @@ public function cleanupRepository(array $params = []) * $params['snapshot'] = (string) The name of the snapshot to clone from * $params['target_snapshot'] = (string) The name of the cloned snapshot to create * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. - * $params['master_timeout'] = (string) Explicit operation timeout for connection to master node + * $params['master_timeout'] = (string) Explicit operation timeout for connection to cluster-manager node * $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 clone(array $params = []) * $params['repository'] = (string) Repository for the snapshot. * $params['snapshot'] = (string) Name of the snapshot. Must be unique in the repository. * $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['master_timeout'] = (string) Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. * $params['wait_for_completion'] = (boolean) If `true`, the request returns a response when the snapshot is complete. If `false`, the request returns a response when the snapshot initializes. (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) @@ -130,7 +130,7 @@ public function create(array $params = []) * * $params['repository'] = (string) A repository name * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. - * $params['master_timeout'] = (string) Explicit operation timeout for connection to master node + * $params['master_timeout'] = (string) Explicit operation timeout for connection to cluster-manager node * $params['timeout'] = (string) Explicit operation timeout * $params['verify'] = (boolean) Whether to verify the repository after creation * $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) @@ -162,7 +162,7 @@ public function createRepository(array $params = []) * $params['repository'] = (string) A repository name * $params['snapshot'] = (string) A comma-separated list of snapshot names * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. - * $params['master_timeout'] = (string) Explicit operation timeout for connection to master node + * $params['master_timeout'] = (string) Explicit operation timeout for connection to cluster-manager node * $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) @@ -190,7 +190,7 @@ public function delete(array $params = []) * * $params['repository'] = (array) Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. - * $params['master_timeout'] = (string) Explicit operation timeout for connection to master node + * $params['master_timeout'] = (string) Explicit operation timeout for connection to cluster-manager node * $params['timeout'] = (string) Explicit operation timeout * $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) @@ -216,11 +216,11 @@ public function deleteRepository(array $params = []) * Returns information about a snapshot. * * $params['repository'] = (string) Comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported. - * $params['snapshot'] = (array) Comma-separated list of snapshot names to retrieve. Also accepts wildcards (*). - To get information about all snapshots in a registered repository, use a wildcard (*) or _all. - To get information about any snapshots that are currently running, use _current. + * $params['snapshot'] = (array) Comma-separated list of snapshot names to retrieve. Also accepts wildcards (`*`). - To get information about all snapshots in a registered repository, use a wildcard (`*`) or `_all`. - To get information about any snapshots that are currently running, use `_current`. * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. - * $params['ignore_unavailable'] = (boolean) If false, the request returns an error for any snapshots that are unavailable. (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['verbose'] = (boolean) If true, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. + * $params['ignore_unavailable'] = (boolean) If `false`, the request returns an error for any snapshots that are unavailable. (Default = false) + * $params['master_timeout'] = (string) Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. + * $params['verbose'] = (boolean) If `true`, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. * $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) @@ -249,7 +249,7 @@ public function get(array $params = []) * $params['repository'] = (array) A comma-separated list of repository names * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) - * $params['master_timeout'] = (string) Explicit operation timeout for connection to master node + * $params['master_timeout'] = (string) Explicit operation timeout for connection to cluster-manager node * $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) @@ -276,7 +276,7 @@ public function getRepository(array $params = []) * $params['repository'] = (string) A repository name * $params['snapshot'] = (string) A snapshot name * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. - * $params['master_timeout'] = (string) Explicit operation timeout for connection to master node + * $params['master_timeout'] = (string) Explicit operation timeout for connection to cluster-manager node * $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) * $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) @@ -309,8 +309,8 @@ public function restore(array $params = []) * $params['repository'] = (string) A repository name * $params['snapshot'] = (array) A comma-separated list of snapshot names * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. - * $params['ignore_unavailable'] = (boolean) Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown (Default = false) - * $params['master_timeout'] = (string) Explicit operation timeout for connection to master node + * $params['ignore_unavailable'] = (boolean) Whether to ignore unavailable snapshots, defaults to `false` which means a SnapshotMissingException is thrown (Default = false) + * $params['master_timeout'] = (string) Explicit operation timeout for connection to cluster-manager node * $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) @@ -338,7 +338,7 @@ public function status(array $params = []) * * $params['repository'] = (string) A repository name * $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. - * $params['master_timeout'] = (string) Explicit operation timeout for connection to master node + * $params['master_timeout'] = (string) Explicit operation timeout for connection to cluster-manager node * $params['timeout'] = (string) Explicit operation timeout * $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/SqlNamespace.php b/src/OpenSearch/Namespaces/SqlNamespace.php index b18300af..783668c2 100644 --- a/src/OpenSearch/Namespaces/SqlNamespace.php +++ b/src/OpenSearch/Namespaces/SqlNamespace.php @@ -27,7 +27,7 @@ class SqlNamespace extends AbstractNamespace /** * Clear the cursor context. * - * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['sanitize'] = (boolean) Specifies whether to escape special characters in the results (Default = true) * $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) @@ -52,7 +52,7 @@ public function close(array $params = []) /** * Collect metrics for the plugin within the interval. * - * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['sanitize'] = (boolean) Specifies whether to escape special characters in the results (Default = true) * $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) @@ -74,7 +74,7 @@ public function getStats(array $params = []) /** * By a stats endpoint, you are able to collect metrics for the plugin within the interval. * - * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $params['sanitize'] = (boolean) Specifies whether to escape special characters in the results (Default = true) * $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) @@ -99,7 +99,7 @@ public function postStats(array $params = []) /** * Adds SQL settings to the standard OpenSearch cluster settings. * - * $params['format'] = (string) A short version of the Accept header, e.g. json, yaml. + * $params['format'] = (string) A short version of the Accept header (for example, `json`, `yaml`). * $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/TransformsNamespace.php b/src/OpenSearch/Namespaces/TransformsNamespace.php index 44716c69..e4599d22 100644 --- a/src/OpenSearch/Namespaces/TransformsNamespace.php +++ b/src/OpenSearch/Namespaces/TransformsNamespace.php @@ -120,7 +120,7 @@ public function preview(array $params = []) } /** - * Create an index transform, or update a transform if if_seq_no and if_primary_term are provided. + * Create an index transform, or update a transform if `if_seq_no` and `if_primary_term` are provided. * * $params['id'] = (string) Transform to create/update * $params['if_primary_term'] = (number) Only perform the operation if the document has this primary term.