Lines Matching defs:params

33      * $params['include_yes_decisions'] = (boolean) Return 'YES' decisions in explanation (default: false)
34 * $params['include_disk_info'] = (boolean) Return information about disk usage and shard sizes (default: false)
35 * $params['body'] = (array) The index, shard, and primary flag to explain. Empty means 'explain a randomly-chosen unassigned shard'
37 * @param array $params Associative array of parameters
41 public function allocationExplain(array $params = [])
43 $body = $this->extractArgument($params, 'body');
47 $endpoint->setParams($params);
55 * $params['name'] = (string) The name of the template
56 * $params['timeout'] = (time) Explicit operation timeout
57 * $params['master_timeout'] = (time) Specify timeout for connection to master
59 * @param array $params Associative array of parameters
63 public function deleteComponentTemplate(array $params = [])
65 $name = $this->extractArgument($params, 'name');
69 $endpoint->setParams($params);
77 * $params['wait_for_removal'] = (boolean) Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. (Default = true)
79 * @param array $params Associative array of parameters
83 public function deleteVotingConfigExclusions(array $params = [])
88 $endpoint->setParams($params);
95 * $params['name'] = (string) The name of the template
96 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
97 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
99 * @param array $params Associative array of parameters
103 public function existsComponentTemplate(array $params = []): bool
105 $name = $this->extractArgument($params, 'name');
108 $params['client']['verbose'] = true;
112 $endpoint->setParams($params);
120 * $params['name'] = (list) The comma separated names of the component templates
121 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
122 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
124 * @param array $params Associative array of parameters
128 public function getComponentTemplate(array $params = [])
130 $name = $this->extractArgument($params, 'name');
134 $endpoint->setParams($params);
142 * $params['flat_settings'] = (boolean) Return settings in flat format (default: false)
143 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
144 * $params['timeout'] = (time) Explicit operation timeout
145 * $params['include_defaults'] = (boolean) Whether to return all default clusters setting. (Default = false)
147 * @param array $params Associative array of parameters
151 public function getSettings(array $params = [])
156 $endpoint->setParams($params);
163 * $params['index'] = (list) Limit the information returned to a specific index
164 * $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)
165 * $params['level'] = (enum) Specify the level of detail for returned information (Options = cluster,indices,shards) (Default = cluster)
166 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
167 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
168 * $params['timeout'] = (time) Explicit operation timeout
169 * $params['wait_for_active_shards'] = (string) Wait until the specified number of shards is active
170 * $params['wait_for_nodes'] = (string) Wait until the specified number of nodes is available
171 * $params['wait_for_events'] = (enum) Wait until all currently queued events with the given priority are processed (Options = immediate,urgent,high,normal,low,languid)
172 * $params['wait_for_no_relocating_shards'] = (boolean) Whether to wait until there are no relocating shards in the cluster
173 * $params['wait_for_no_initializing_shards'] = (boolean) Whether to wait until there are no initializing shards in the cluster
174 * $params['wait_for_status'] = (enum) Wait until cluster is in a specific state (Options = green,yellow,red)
176 * @param array $params Associative array of parameters
180 public function health(array $params = [])
182 $index = $this->extractArgument($params, 'index');
186 $endpoint->setParams($params);
194 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
195 * $params['master_timeout'] = (time) Specify timeout for connection to master
197 * @param array $params Associative array of parameters
201 public function pendingTasks(array $params = [])
206 $endpoint->setParams($params);
213 * $params['node_ids'] = (string) A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_names.
214 * $params['node_names'] = (string) A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_ids.
215 * $params['timeout'] = (time) Explicit operation timeout (Default = 30s)
217 * @param array $params Associative array of parameters
221 public function postVotingConfigExclusions(array $params = [])
226 $endpoint->setParams($params);
233 * $params['name'] = (string) The name of the template
234 * $params['create'] = (boolean) Whether the index template should only be added if new or can also replace an existing one (Default = false)
235 * $params['timeout'] = (time) Explicit operation timeout
236 * $params['master_timeout'] = (time) Specify timeout for connection to master
237 * $params['body'] = (array) The template definition (Required)
239 * @param array $params Associative array of parameters
243 public function putComponentTemplate(array $params = [])
245 $name = $this->extractArgument($params, 'name');
246 $body = $this->extractArgument($params, 'body');
250 $endpoint->setParams($params);
259 * $params['flat_settings'] = (boolean) Return settings in flat format (default: false)
260 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
261 * $params['timeout'] = (time) Explicit operation timeout
262 * $params['body'] = (array) The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). (Required)
264 * @param array $params Associative array of parameters
268 public function putSettings(array $params = [])
270 $body = $this->extractArgument($params, 'body');
274 $endpoint->setParams($params);
283 * @param array $params Associative array of parameters
287 public function remoteInfo(array $params = [])
292 $endpoint->setParams($params);
299 * $params['dry_run'] = (boolean) Simulate the operation only and return the resulting state
300 * $params['explain'] = (boolean) Return an explanation of why the commands can or cannot be executed
301 * $params['retry_failed'] = (boolean) Retries allocation of shards that are blocked due to too many subsequent allocation failures
302 * $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,version)
303 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
304 * $params['timeout'] = (time) Explicit operation timeout
305 * $params['body'] = (array) The definition of `commands` to perform (`move`, `cancel`, `allocate`)
307 * @param array $params Associative array of parameters
311 public function reroute(array $params = [])
313 $body = $this->extractArgument($params, 'body');
317 $endpoint->setParams($params);
325 * $params['metric'] = (list) Limit the information returned to the specified metrics
326 * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
327 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
328 * $params['master_timeout'] = (time) Specify timeout for connection to master
329 * $params['flat_settings'] = (boolean) Return settings in flat format (default: false)
330 * $params['wait_for_metadata_version'] = (number) Wait for the metadata version to be equal or greater than the specified metadata version
331 * $params['wait_for_timeout'] = (time) The maximum time to wait for wait_for_metadata_version before timing out
332 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
333 * $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)
334 * $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)
336 * @param array $params Associative array of parameters
340 public function state(array $params = [])
342 $metric = $this->extractArgument($params, 'metric');
343 $index = $this->extractArgument($params, 'index');
347 $endpoint->setParams($params);
356 * $params['node_id'] = (list) A 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
357 * $params['flat_settings'] = (boolean) Return settings in flat format (default: false)
358 * $params['timeout'] = (time) Explicit operation timeout
360 * @param array $params Associative array of parameters
364 public function stats(array $params = [])
366 $node_id = $this->extractArgument($params, 'node_id');
370 $endpoint->setParams($params);