From 4c4beb18533d26a67a5b3cd7c1e1b7ddad50cabb Mon Sep 17 00:00:00 2001 From: Soner Sayakci Date: Fri, 24 Jun 2022 20:36:47 +0000 Subject: [PATCH] feat: update all comments Signed-off-by: Soner Sayakci --- src/OpenSearch/Client.php | 8 +- src/OpenSearch/Endpoints/AbstractEndpoint.php | 4 +- src/OpenSearch/Namespaces/CatNamespace.php | 52 ++++++------ .../Namespaces/ClusterNamespace.php | 30 +++---- .../Namespaces/DanglingIndicesNamespace.php | 4 +- .../Namespaces/IndicesNamespace.php | 80 +++++++++---------- src/OpenSearch/Namespaces/IngestNamespace.php | 6 +- .../SearchableSnapshotsNamespace.php | 2 +- .../Namespaces/SnapshotNamespace.php | 24 +++--- tests/Endpoints/AbstractEndpointTest.php | 4 +- 10 files changed, 107 insertions(+), 107 deletions(-) diff --git a/src/OpenSearch/Client.php b/src/OpenSearch/Client.php index b0d9619ba..fd2c8e92f 100644 --- a/src/OpenSearch/Client.php +++ b/src/OpenSearch/Client.php @@ -395,7 +395,7 @@ public function deleteByQueryRethrottle(array $params = []) /** * $params['id'] = (string) Script ID * $params['timeout'] = (time) Explicit operation timeout - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * * @param array $params Associative array of parameters * @return array @@ -568,7 +568,7 @@ public function get(array $params = []) } /** * $params['id'] = (string) Script ID - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * * @param array $params Associative array of parameters * @return array @@ -827,7 +827,7 @@ public function ping(array $params = []): bool * $params['id'] = (string) Script ID (Required) * $params['context'] = (string) Script context * $params['timeout'] = (time) Explicit operation timeout - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * $params['body'] = (array) The document (Required) * * @param array $params Associative array of parameters @@ -1048,7 +1048,7 @@ public function search(array $params = []) * $params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices * $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random) * $params['routing'] = (string) Specific routing value - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) + * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster manager node (default: false) * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) * $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * $params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open) diff --git a/src/OpenSearch/Endpoints/AbstractEndpoint.php b/src/OpenSearch/Endpoints/AbstractEndpoint.php index 3af5024e4..13f5a30dc 100644 --- a/src/OpenSearch/Endpoints/AbstractEndpoint.php +++ b/src/OpenSearch/Endpoints/AbstractEndpoint.php @@ -307,10 +307,10 @@ private function checkForDeprecations(): void if (array_key_exists($key, $deprecations)) { $val = $deprecations[$key]; - $msg = sprintf('The parameter "%s" is deprecated and will be removed without replacement', $key); + $msg = sprintf('The parameter "%s" is deprecated and will be removed without replacement in the next major version', $key); if ($val) { - $msg = sprintf('The parameter "%s" is deprecated and will be replaced with parameter "%s"', $key, $val); + $msg = sprintf('The parameter "%s" is deprecated and will be replaced with parameter "%s" in the next major version', $key, $val); } trigger_error($msg, E_USER_DEPRECATED); diff --git a/src/OpenSearch/Namespaces/CatNamespace.php b/src/OpenSearch/Namespaces/CatNamespace.php index c9f4267ad..9d43fdb61 100644 --- a/src/OpenSearch/Namespaces/CatNamespace.php +++ b/src/OpenSearch/Namespaces/CatNamespace.php @@ -32,7 +32,7 @@ class CatNamespace extends AbstractNamespace /** * $params['name'] = (list) A comma-separated list of alias names to return * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) + * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster_manager node (default: false) * $params['h'] = (list) Comma-separated list of column names to display * $params['help'] = (boolean) Return help information (Default = false) * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by @@ -57,8 +57,8 @@ public function aliases(array $params = []) * $params['node_id'] = (list) A comma-separated list of node IDs or names to limit the returned information * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml * $params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb) - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster_manager node (default: false) + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['h'] = (list) Comma-separated list of column names to display * $params['help'] = (boolean) Return help information (Default = false) * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by @@ -162,8 +162,8 @@ public function help(array $params = []) * $params['index'] = (list) A comma-separated list of index names to limit the returned information * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml * $params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb) - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster_manager node (default: false) + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['h'] = (list) Comma-separated list of column names to display * $params['health'] = (enum) A health status ("green", "yellow", or "red" to filter only indices matching the specified health status (Options = green,yellow,red) * $params['help'] = (boolean) Return help information (Default = false) @@ -190,8 +190,8 @@ public function indices(array $params = []) } /** * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster_manager node (default: false) + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['h'] = (list) Comma-separated list of column names to display * $params['help'] = (boolean) Return help information (Default = false) * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by @@ -212,8 +212,8 @@ public function master(array $params = []) } /** * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) - * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster_manager node (default: false) + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['h'] = (list) Comma-separated list of column names to display * $params['help'] = (boolean) Return help information (Default = false) * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by @@ -232,8 +232,8 @@ public function clusterManager(array $params = []) } /** * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster_manager node (default: false) + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['h'] = (list) Comma-separated list of column names to display * $params['help'] = (boolean) Return help information (Default = false) * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by @@ -254,8 +254,8 @@ public function nodeattrs(array $params = []) * $params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb) * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml * $params['full_id'] = (boolean) Return the full node ID instead of the shortened version (default: false) - * $params['local'] = (boolean) Calculate the selected nodes using the local cluster state rather than the state from master node (default: false) - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['local'] = (boolean) Calculate the selected nodes using the local cluster state rather than the state from cluster_manager node (default: false) + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['h'] = (list) Comma-separated list of column names to display * $params['help'] = (boolean) Return help information (Default = false) * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by @@ -275,8 +275,8 @@ public function nodes(array $params = []) } /** * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster_manager node (default: false) + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['h'] = (list) Comma-separated list of column names to display * $params['help'] = (boolean) Return help information (Default = false) * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by @@ -296,8 +296,8 @@ public function pendingTasks(array $params = []) } /** * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster_manager node (default: false) + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['h'] = (list) Comma-separated list of column names to display * $params['help'] = (boolean) Return help information (Default = false) * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by @@ -342,8 +342,8 @@ public function recovery(array $params = []) } /** * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (Default = false) - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster_manager node (Default = false) + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['h'] = (list) Comma-separated list of column names to display * $params['help'] = (boolean) Return help information (Default = false) * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by @@ -387,8 +387,8 @@ public function segments(array $params = []) * $params['index'] = (list) A comma-separated list of index names to limit the returned information * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml * $params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb) - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster_manager node (default: false) + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['h'] = (list) Comma-separated list of column names to display * $params['help'] = (boolean) Return help information (Default = false) * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by @@ -413,7 +413,7 @@ public function shards(array $params = []) * $params['repository'] = (list) Name of repository from which to fetch the snapshot information * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml * $params['ignore_unavailable'] = (boolean) Set to true to ignore unavailable snapshots (Default = false) - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['h'] = (list) Comma-separated list of column names to display * $params['help'] = (boolean) Return help information (Default = false) * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by @@ -460,8 +460,8 @@ public function tasks(array $params = []) /** * $params['name'] = (string) A pattern that returned template names must match * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster_manager node (default: false) + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['h'] = (list) Comma-separated list of column names to display * $params['help'] = (boolean) Return help information (Default = false) * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by @@ -485,8 +485,8 @@ public function templates(array $params = []) * $params['thread_pool_patterns'] = (list) A comma-separated list of regular-expressions to filter the thread pools in the output * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml * $params['size'] = (enum) The multiplier in which to display values (Options = ,k,m,g,t,p) - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster_manager node (default: false) + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['h'] = (list) Comma-separated list of column names to display * $params['help'] = (boolean) Return help information (Default = false) * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by diff --git a/src/OpenSearch/Namespaces/ClusterNamespace.php b/src/OpenSearch/Namespaces/ClusterNamespace.php index bfc9320b7..72e1a579b 100644 --- a/src/OpenSearch/Namespaces/ClusterNamespace.php +++ b/src/OpenSearch/Namespaces/ClusterNamespace.php @@ -51,7 +51,7 @@ public function allocationExplain(array $params = []) /** * $params['name'] = (string) The name of the template * $params['timeout'] = (time) Explicit operation timeout - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * * @param array $params Associative array of parameters * @return array @@ -87,8 +87,8 @@ public function deleteVotingConfigExclusions(array $params = []) } /** * $params['name'] = (string) The name of the template - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) + * $params['cluster_manager_timeout'] = (time) Explicit 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) * * @param array $params Associative array of parameters * @return bool @@ -113,8 +113,8 @@ public function existsComponentTemplate(array $params = []): bool } /** * $params['name'] = (list) The comma separated names of the component templates - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) + * $params['cluster_manager_timeout'] = (time) Explicit 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) * * @param array $params Associative array of parameters * @return array @@ -136,7 +136,7 @@ public function getComponentTemplate(array $params = []) } /** * $params['flat_settings'] = (boolean) Return settings in flat format (default: false) - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['timeout'] = (time) Explicit operation timeout * $params['include_defaults'] = (boolean) Whether to return all default clusters setting. (Default = false) * @@ -155,8 +155,8 @@ public function getSettings(array $params = []) * $params['index'] = (list) Limit the information returned to a specific index * $params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = all) * $params['level'] = (enum) Specify the level of detail for returned information (Options = cluster,indices,shards) (Default = cluster) - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster_manager node (default: false) + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['timeout'] = (time) Explicit operation timeout * $params['wait_for_active_shards'] = (string) Wait until the specified number of shards is active * $params['wait_for_nodes'] = (string) Wait until the specified number of nodes is available @@ -180,8 +180,8 @@ public function health(array $params = []) return $this->performRequest($endpoint); } /** - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster_manager node (default: false) + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * * @param array $params Associative array of parameters * @return array @@ -214,7 +214,7 @@ public function postVotingConfigExclusions(array $params = []) * $params['name'] = (string) The name of the template * $params['create'] = (boolean) Whether the index template should only be added if new or can also replace an existing one (Default = false) * $params['timeout'] = (time) Explicit operation timeout - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * $params['body'] = (array) The template definition (Required) * * @param array $params Associative array of parameters @@ -239,7 +239,7 @@ public function putComponentTemplate(array $params = []) } /** * $params['flat_settings'] = (boolean) Return settings in flat format (default: false) - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['timeout'] = (time) Explicit operation timeout * $params['body'] = (array) The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). (Required) * @@ -275,7 +275,7 @@ public function remoteInfo(array $params = []) * $params['explain'] = (boolean) Return an explanation of why the commands can or cannot be executed * $params['retry_failed'] = (boolean) Retries allocation of shards that are blocked due to too many subsequent allocation failures * $params['metric'] = (list) Limit the information returned to the specified metrics. Defaults to all but metadata (Options = _all,blocks,metadata,nodes,routing_table,master_node,cluster_manager_node,version) - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['timeout'] = (time) Explicit operation timeout * $params['body'] = (array) The definition of `commands` to perform (`move`, `cancel`, `allocate`) * @@ -296,8 +296,8 @@ public function reroute(array $params = []) /** * $params['metric'] = (list) Limit the information returned to the specified metrics * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster_manager node (default: false) + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * $params['flat_settings'] = (boolean) Return settings in flat format (default: false) * $params['wait_for_metadata_version'] = (number) Wait for the metadata version to be equal or greater than the specified metadata version * $params['wait_for_timeout'] = (time) The maximum time to wait for wait_for_metadata_version before timing out diff --git a/src/OpenSearch/Namespaces/DanglingIndicesNamespace.php b/src/OpenSearch/Namespaces/DanglingIndicesNamespace.php index f5e515bb1..62c5b35b9 100644 --- a/src/OpenSearch/Namespaces/DanglingIndicesNamespace.php +++ b/src/OpenSearch/Namespaces/DanglingIndicesNamespace.php @@ -33,7 +33,7 @@ class DanglingIndicesNamespace extends AbstractNamespace * $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['timeout'] = (time) Explicit operation timeout - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * * @param array $params Associative array of parameters * @return array @@ -53,7 +53,7 @@ public function deleteDanglingIndex(array $params = []) * $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['timeout'] = (time) Explicit operation timeout - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * * @param array $params Associative array of parameters * @return array diff --git a/src/OpenSearch/Namespaces/IndicesNamespace.php b/src/OpenSearch/Namespaces/IndicesNamespace.php index 2b5d06f5f..3255f8b55 100644 --- a/src/OpenSearch/Namespaces/IndicesNamespace.php +++ b/src/OpenSearch/Namespaces/IndicesNamespace.php @@ -33,7 +33,7 @@ class IndicesNamespace extends AbstractNamespace * $params['index'] = (list) A comma separated list of indices to add a block to * $params['block'] = (string) The block to add (one of read, write, read_only or metadata) * $params['timeout'] = (time) Explicit operation timeout - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) * $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * $params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open) @@ -102,7 +102,7 @@ public function clearCache(array $params = []) * $params['index'] = (string) The name of the source index to clone * $params['target'] = (string) The name of the target index to clone into * $params['timeout'] = (time) Explicit operation timeout - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * $params['wait_for_active_shards'] = (string) Set the number of active shards to wait for on the cloned index before the operation returns. * $params['body'] = (array) The configuration for the target index (`settings` and `aliases`) * @@ -127,7 +127,7 @@ public function clone(array $params = []) /** * $params['index'] = (list) A comma separated list of indices to close * $params['timeout'] = (time) Explicit operation timeout - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) * $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * $params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open) @@ -151,7 +151,7 @@ public function close(array $params = []) * $params['index'] = (string) The name of the index * $params['wait_for_active_shards'] = (string) Set the number of active shards to wait for before the operation returns. * $params['timeout'] = (time) Explicit operation timeout - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * $params['body'] = (array) The configuration for the index (`settings` and `mappings`) * * @param array $params Associative array of parameters @@ -173,7 +173,7 @@ public function create(array $params = []) /** * $params['index'] = (list) A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices * $params['timeout'] = (time) Explicit operation timeout - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * $params['ignore_unavailable'] = (boolean) Ignore unavailable indexes (default: false) * $params['allow_no_indices'] = (boolean) Ignore if a wildcard expression resolves to no concrete indices (default: false) * $params['expand_wildcards'] = (enum) Whether wildcard expressions should get expanded to open or closed indices (default: open) (Options = open,closed,hidden,none,all) (Default = open) @@ -196,7 +196,7 @@ public function delete(array $params = []) * $params['index'] = (list) A comma-separated list of index names (supports wildcards); use `_all` for all indices (Required) * $params['name'] = (list) A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. (Required) * $params['timeout'] = (time) Explicit timestamp for the document - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * * @param array $params Associative array of parameters * @return array @@ -217,7 +217,7 @@ public function deleteAlias(array $params = []) /** * $params['name'] = (string) The name of the template * $params['timeout'] = (time) Explicit operation timeout - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * * @param array $params Associative array of parameters * @return array @@ -240,7 +240,7 @@ public function deleteIndexTemplate(array $params = []) /** * $params['name'] = (string) The name of the template * $params['timeout'] = (time) Explicit operation timeout - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * * @param array $params Associative array of parameters * @return array @@ -258,7 +258,7 @@ public function deleteTemplate(array $params = []) } /** * $params['index'] = (list) A comma-separated list of index names - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) + * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster_manager node (default: false) * $params['ignore_unavailable'] = (boolean) Ignore unavailable indexes (default: false) * $params['allow_no_indices'] = (boolean) Ignore if a wildcard expression resolves to no concrete indices (default: false) * $params['expand_wildcards'] = (enum) Whether wildcard expressions should get expanded to open or closed indices (default: open) (Options = open,closed,hidden,none,all) (Default = open) @@ -288,7 +288,7 @@ public function exists(array $params = []): bool * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) * $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * $params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = all) - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) + * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster_manager node (default: false) * * @param array $params Associative array of parameters * @return bool @@ -312,8 +312,8 @@ public function existsAlias(array $params = []): bool /** * $params['name'] = (string) The name of the template * $params['flat_settings'] = (boolean) Return settings in flat format (default: false) - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) + * $params['cluster_manager_timeout'] = (time) Explicit 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) * * @param array $params Associative array of parameters * @return bool @@ -339,8 +339,8 @@ public function existsIndexTemplate(array $params = []): bool /** * $params['name'] = (list) The comma separated names of the index templates * $params['flat_settings'] = (boolean) Return settings in flat format (default: false) - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) + * $params['cluster_manager_timeout'] = (time) Explicit 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) * * @param array $params Associative array of parameters * @return bool @@ -406,13 +406,13 @@ public function forcemerge(array $params = []) } /** * $params['index'] = (list) A comma-separated list of index names - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) + * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster_manager node (default: false) * $params['ignore_unavailable'] = (boolean) Ignore unavailable indexes (default: false) * $params['allow_no_indices'] = (boolean) Ignore if a wildcard expression resolves to no concrete indices (default: false) * $params['expand_wildcards'] = (enum) Whether wildcard expressions should get expanded to open or closed indices (default: open) (Options = open,closed,hidden,none,all) (Default = open) * $params['flat_settings'] = (boolean) Return settings in flat format (default: false) * $params['include_defaults'] = (boolean) Whether to return all default setting for each of the indices. (Default = false) - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * * @param array $params Associative array of parameters * @return array @@ -434,7 +434,7 @@ public function get(array $params = []) * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) * $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * $params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = all) - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) + * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster_manager node (default: false) * * @param array $params Associative array of parameters * @return array @@ -459,7 +459,7 @@ public function getAlias(array $params = []) * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) * $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * $params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open) - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) + * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster_manager node (default: false) * * @param array $params Associative array of parameters * @return array @@ -480,8 +480,8 @@ public function getFieldMapping(array $params = []) /** * $params['name'] = (list) The comma separated names of the index templates * $params['flat_settings'] = (boolean) Return settings in flat format (default: false) - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) + * $params['cluster_manager_timeout'] = (time) Explicit 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) * * @param array $params Associative array of parameters * @return array @@ -506,8 +506,8 @@ public function getIndexTemplate(array $params = []) * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) * $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * $params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open) - * $params['master_timeout'] = (time) Specify timeout for connection to master - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager + * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster_manager node (default: false) * * @param array $params Associative array of parameters * @return array @@ -526,12 +526,12 @@ public function getMapping(array $params = []) /** * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices * $params['name'] = (list) The name of the settings that should be included - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) * $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * $params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = all) * $params['flat_settings'] = (boolean) Return settings in flat format (default: false) - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) + * $params['local'] = (boolean) Return local information, do not retrieve the state from cluster_manager node (default: false) * $params['include_defaults'] = (boolean) Whether to return all default setting for each of the indices. (Default = false) * * @param array $params Associative array of parameters @@ -553,8 +553,8 @@ public function getSettings(array $params = []) /** * $params['name'] = (list) The comma separated names of the index templates * $params['flat_settings'] = (boolean) Return settings in flat format (default: false) - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) + * $params['cluster_manager_timeout'] = (time) Explicit 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) * * @param array $params Associative array of parameters * @return array @@ -593,7 +593,7 @@ public function getUpgrade(array $params = []) /** * $params['index'] = (list) A comma separated list of indices to open * $params['timeout'] = (time) Explicit operation timeout - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) * $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * $params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = closed) @@ -617,7 +617,7 @@ public function open(array $params = []) * $params['index'] = (list) A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. (Required) * $params['name'] = (string) The name of the alias to be created or updated (Required) * $params['timeout'] = (time) Explicit timestamp for the document - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * $params['body'] = (array) The settings for the alias, such as `routing` or `filter` * * @param array $params Associative array of parameters @@ -642,7 +642,7 @@ public function putAlias(array $params = []) * $params['name'] = (string) The name of the template * $params['create'] = (boolean) Whether the index template should only be added if new or can also replace an existing one (Default = false) * $params['cause'] = (string) User defined reason for creating/updating the index template (Default = ) - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * $params['body'] = (array) The template definition (Required) * * @param array $params Associative array of parameters @@ -668,7 +668,7 @@ public function putIndexTemplate(array $params = []) /** * $params['index'] = (list) A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. * $params['timeout'] = (time) Explicit operation timeout - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) * $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * $params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open) @@ -693,7 +693,7 @@ public function putMapping(array $params = []) } /** * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * $params['timeout'] = (time) Explicit operation timeout * $params['preserve_existing'] = (boolean) Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false` * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -722,7 +722,7 @@ public function putSettings(array $params = []) * $params['name'] = (string) The name of the template * $params['order'] = (number) The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) * $params['create'] = (boolean) Whether the index template should only be added if new or can also replace an existing one (Default = false) - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * $params['body'] = (array) The template definition (Required) * * @param array $params Associative array of parameters @@ -807,7 +807,7 @@ public function resolveIndex(array $params = []) * $params['new_index'] = (string) The name of the rollover index * $params['timeout'] = (time) Explicit operation timeout * $params['dry_run'] = (boolean) If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * $params['wait_for_active_shards'] = (string) Set the number of active shards to wait for on the newly created rollover index before the operation returns. * $params['body'] = (array) The conditions that needs to be met for executing rollover * @@ -876,7 +876,7 @@ public function shardStores(array $params = []) * $params['target'] = (string) The name of the target index to shrink into * $params['copy_settings'] = (boolean) whether or not to copy settings from the source index (defaults to false) * $params['timeout'] = (time) Explicit operation timeout - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * $params['wait_for_active_shards'] = (string) Set the number of active shards to wait for on the shrunken index before the operation returns. * $params['body'] = (array) The configuration for the target index (`settings` and `aliases`) * @@ -902,7 +902,7 @@ public function shrink(array $params = []) * $params['name'] = (string) The name of the index (it must be a concrete index name) * $params['create'] = (boolean) Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one (Default = false) * $params['cause'] = (string) User defined reason for dry-run creating the new template for simulation purposes (Default = ) - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * $params['body'] = (array) New index template definition, which will be included in the simulation, as if it already exists in the system * * @param array $params Associative array of parameters @@ -929,7 +929,7 @@ public function simulateIndexTemplate(array $params = []) * $params['name'] = (string) The name of the index template * $params['create'] = (boolean) Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one (Default = false) * $params['cause'] = (string) User defined reason for dry-run creating the new template for simulation purposes (Default = ) - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * $params['body'] = (array) New index template definition to be simulated, if no index template name is specified * * @param array $params Associative array of parameters @@ -957,7 +957,7 @@ public function simulateTemplate(array $params = []) * $params['target'] = (string) The name of the target index to split into * $params['copy_settings'] = (boolean) whether or not to copy settings from the source index (defaults to false) * $params['timeout'] = (time) Explicit operation timeout - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * $params['wait_for_active_shards'] = (string) Set the number of active shards to wait for on the shrunken index before the operation returns. * $params['body'] = (array) The configuration for the target index (`settings` and `aliases`) * @@ -1011,7 +1011,7 @@ public function stats(array $params = []) } /** * $params['timeout'] = (time) Request timeout - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * $params['body'] = (array) The definition of `actions` to perform (Required) * * @param array $params Associative array of parameters @@ -1136,7 +1136,7 @@ public function deleteDataStream(array $params = []) /** * $params['index'] = (string) The name of the index to freeze * $params['timeout'] = (time) Explicit operation timeout - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) * $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * $params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = closed) @@ -1196,7 +1196,7 @@ public function reloadSearchAnalyzers(array $params = []) /** * $params['index'] = (string) The name of the index to unfreeze * $params['timeout'] = (time) Explicit operation timeout - * $params['master_timeout'] = (time) Specify timeout for connection to master + * $params['cluster_manager_timeout'] = (time) Specify timeout for connection to cluster_manager * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed) * $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * $params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = closed) diff --git a/src/OpenSearch/Namespaces/IngestNamespace.php b/src/OpenSearch/Namespaces/IngestNamespace.php index 9177f295b..029bcfb27 100644 --- a/src/OpenSearch/Namespaces/IngestNamespace.php +++ b/src/OpenSearch/Namespaces/IngestNamespace.php @@ -31,7 +31,7 @@ class IngestNamespace extends AbstractNamespace { /** * $params['id'] = (string) Pipeline ID - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['timeout'] = (time) Explicit operation timeout * * @param array $params Associative array of parameters @@ -50,7 +50,7 @@ public function deletePipeline(array $params = []) } /** * $params['id'] = (string) Comma separated list of pipeline ids. Wildcards supported - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * * @param array $params Associative array of parameters * @return array @@ -81,7 +81,7 @@ public function processorGrok(array $params = []) } /** * $params['id'] = (string) Pipeline ID - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['timeout'] = (time) Explicit operation timeout * $params['body'] = (array) The ingest definition (Required) * diff --git a/src/OpenSearch/Namespaces/SearchableSnapshotsNamespace.php b/src/OpenSearch/Namespaces/SearchableSnapshotsNamespace.php index 2e170a064..753f497b3 100644 --- a/src/OpenSearch/Namespaces/SearchableSnapshotsNamespace.php +++ b/src/OpenSearch/Namespaces/SearchableSnapshotsNamespace.php @@ -56,7 +56,7 @@ public function clearCache(array $params = []) /** * $params['repository'] = (string) The name of the repository containing the snapshot of the index to mount * $params['snapshot'] = (string) The name of the snapshot of the index to mount - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['cluster_manager_timeout'] = (time) 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['body'] = (array) The restore configuration for mounting the snapshot as searchable (Required) * diff --git a/src/OpenSearch/Namespaces/SnapshotNamespace.php b/src/OpenSearch/Namespaces/SnapshotNamespace.php index 00cd6de20..3fcdd60e3 100644 --- a/src/OpenSearch/Namespaces/SnapshotNamespace.php +++ b/src/OpenSearch/Namespaces/SnapshotNamespace.php @@ -31,7 +31,7 @@ class SnapshotNamespace extends AbstractNamespace { /** * $params['repository'] = (string) A repository name - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['timeout'] = (time) Explicit operation timeout * * @param array $params Associative array of parameters @@ -52,7 +52,7 @@ public function cleanupRepository(array $params = []) * $params['repository'] = (string) A repository name * $params['snapshot'] = (string) The name of the snapshot to clone from * $params['target_snapshot'] = (string) The name of the cloned snapshot to create - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['body'] = (array) The snapshot clone definition (Required) * * @param array $params Associative array of parameters @@ -78,7 +78,7 @@ public function clone(array $params = []) /** * $params['repository'] = (string) A repository name * $params['snapshot'] = (string) A snapshot name - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['cluster_manager_timeout'] = (time) 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['body'] = (array) The snapshot definition * @@ -102,7 +102,7 @@ public function create(array $params = []) } /** * $params['repository'] = (string) A repository name - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['timeout'] = (time) Explicit operation timeout * $params['verify'] = (boolean) Whether to verify the repository after creation * $params['body'] = (array) The repository definition (Required) @@ -126,7 +126,7 @@ public function createRepository(array $params = []) /** * $params['repository'] = (string) A repository name * $params['snapshot'] = (string) A snapshot name - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * * @param array $params Associative array of parameters * @return array @@ -146,7 +146,7 @@ public function delete(array $params = []) } /** * $params['repository'] = (list) Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['timeout'] = (time) Explicit operation timeout * * @param array $params Associative array of parameters @@ -166,7 +166,7 @@ public function deleteRepository(array $params = []) /** * $params['repository'] = (string) A repository name * $params['snapshot'] = (list) A comma-separated list of snapshot names - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['cluster_manager_timeout'] = (time) Explicit 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 * $params['verbose'] = (boolean) Whether to show verbose snapshot info or only show the basic info found in the repository index blob * @@ -188,8 +188,8 @@ public function get(array $params = []) } /** * $params['repository'] = (list) A comma-separated list of repository names - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node - * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) + * $params['cluster_manager_timeout'] = (time) Explicit 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) * * @param array $params Associative array of parameters * @return array @@ -208,7 +208,7 @@ public function getRepository(array $params = []) /** * $params['repository'] = (string) A repository name * $params['snapshot'] = (string) A snapshot name - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['cluster_manager_timeout'] = (time) 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['body'] = (array) Details of what to restore * @@ -233,7 +233,7 @@ public function restore(array $params = []) /** * $params['repository'] = (string) A repository name * $params['snapshot'] = (list) A comma-separated list of snapshot names - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['cluster_manager_timeout'] = (time) Explicit 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 * * @param array $params Associative array of parameters @@ -254,7 +254,7 @@ public function status(array $params = []) } /** * $params['repository'] = (string) A repository name - * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node + * $params['cluster_manager_timeout'] = (time) Explicit operation timeout for connection to cluster_manager node * $params['timeout'] = (time) Explicit operation timeout * * @param array $params Associative array of parameters diff --git a/tests/Endpoints/AbstractEndpointTest.php b/tests/Endpoints/AbstractEndpointTest.php index c999e5a68..19004ba1e 100644 --- a/tests/Endpoints/AbstractEndpointTest.php +++ b/tests/Endpoints/AbstractEndpointTest.php @@ -114,7 +114,7 @@ public function deprecationProvider(): iterable 'old_without_replacement' => 1, ], true, - 'The parameter "old_without_replacement" is deprecated and will be removed without replacement' + 'The parameter "old_without_replacement" is deprecated and will be removed without replacement in the next major version' ]; yield 'replaced with replacement' => [ @@ -122,7 +122,7 @@ public function deprecationProvider(): iterable 'old' => 1, ], true, - 'The parameter "old" is deprecated and will be replaced with parameter "new"' + 'The parameter "old" is deprecated and will be replaced with parameter "new" in the next major version' ]; } }