Lines Matching refs:params
33 * $params['name'] = (list) A comma-separated list of alias names to return
34 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
35 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
36 * $params['h'] = (list) Comma-separated list of column names to display
37 * $params['help'] = (boolean) Return help information (Default = false)
38 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
39 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
40 * $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)
42 * @param array $params Associative array of parameters
46 public function aliases(array $params = [])
48 $name = $this->extractArgument($params, 'name');
52 $endpoint->setParams($params);
60 * $params['node_id'] = (list) A comma-separated list of node IDs or names to limit the returned information
61 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
62 * $params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb)
63 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
64 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
65 * $params['h'] = (list) Comma-separated list of column names to display
66 * $params['help'] = (boolean) Return help information (Default = false)
67 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
68 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
70 * @param array $params Associative array of parameters
74 public function allocation(array $params = [])
76 $node_id = $this->extractArgument($params, 'node_id');
80 $endpoint->setParams($params);
88 * $params['index'] = (list) A comma-separated list of index names to limit the returned information
89 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
90 * $params['h'] = (list) Comma-separated list of column names to display
91 * $params['help'] = (boolean) Return help information (Default = false)
92 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
93 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
95 * @param array $params Associative array of parameters
99 public function count(array $params = [])
101 $index = $this->extractArgument($params, 'index');
105 $endpoint->setParams($params);
113 * $params['fields'] = (list) A comma-separated list of fields to return the fielddata size
114 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
115 * $params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb)
116 * $params['h'] = (list) Comma-separated list of column names to display
117 * $params['help'] = (boolean) Return help information (Default = false)
118 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
119 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
121 * @param array $params Associative array of parameters
125 public function fielddata(array $params = [])
127 $fields = $this->extractArgument($params, 'fields');
131 $endpoint->setParams($params);
139 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
140 * $params['h'] = (list) Comma-separated list of column names to display
141 * $params['help'] = (boolean) Return help information (Default = false)
142 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
143 * $params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos)
144 * $params['ts'] = (boolean) Set to false to disable timestamping (Default = true)
145 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
147 * @param array $params Associative array of parameters
151 public function health(array $params = [])
156 $endpoint->setParams($params);
163 * $params['help'] = (boolean) Return help information (Default = false)
164 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
166 * @param array $params Associative array of parameters
170 public function help(array $params = [])
175 $endpoint->setParams($params);
182 * $params['index'] = (list) A comma-separated list of index names to limit the returned information
183 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
184 * $params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb)
185 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
186 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
187 * $params['h'] = (list) Comma-separated list of column names to display
188 * $params['health'] = (enum) A health status ("green", "yellow", or "red" to filter only indices matching the specified health status (Options = green,yellow,red)
189 * $params['help'] = (boolean) Return help information (Default = false)
190 * $params['pri'] = (boolean) Set to true to return stats only for primary shards (Default = false)
191 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
192 * $params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos)
193 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
194 * $params['include_unloaded_segments'] = (boolean) If set to true segment stats will include stats for segments that are not currently loaded into memory (Default = false)
195 * $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)
197 * @param array $params Associative array of parameters
201 public function indices(array $params = [])
203 $index = $this->extractArgument($params, 'index');
207 $endpoint->setParams($params);
215 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
216 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
217 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
218 * $params['h'] = (list) Comma-separated list of column names to display
219 * $params['help'] = (boolean) Return help information (Default = false)
220 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
221 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
223 * @param array $params Associative array of parameters
227 public function master(array $params = [])
232 $endpoint->setParams($params);
239 * $params['id'] = (string) The ID of the data frame analytics to fetch
240 * $params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified)
241 * $params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb)
242 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
243 * $params['h'] = (list) Comma-separated list of column names to display
244 * $params['help'] = (boolean) Return help information (Default = false)
245 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
246 * $params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos)
247 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
249 * @param array $params Associative array of parameters
253 public function mlDataFrameAnalytics(array $params = [])
255 $id = $this->extractArgument($params, 'id');
259 $endpoint->setParams($params);
267 * $params['datafeed_id'] = (string) The ID of the datafeeds stats to fetch
268 * $params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
269 * $params['allow_no_datafeeds'] = (boolean) Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
270 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
271 * $params['h'] = (list) Comma-separated list of column names to display
272 * $params['help'] = (boolean) Return help information (Default = false)
273 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
274 * $params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos)
275 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
277 * @param array $params Associative array of parameters
281 public function mlDatafeeds(array $params = [])
283 $datafeed_id = $this->extractArgument($params, 'datafeed_id');
287 $endpoint->setParams($params);
295 * $params['job_id'] = (string) The ID of the jobs stats to fetch
296 * $params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
297 * $params['allow_no_jobs'] = (boolean) Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
298 * $params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb)
299 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
300 * $params['h'] = (list) Comma-separated list of column names to display
301 * $params['help'] = (boolean) Return help information (Default = false)
302 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
303 * $params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos)
304 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
306 * @param array $params Associative array of parameters
310 public function mlJobs(array $params = [])
312 $job_id = $this->extractArgument($params, 'job_id');
316 $endpoint->setParams($params);
324 * $params['model_id'] = (string) The ID of the trained models stats to fetch
325 * $params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified) (Default = true)
326 * $params['from'] = (int) skips a number of trained models (Default = 0)
327 * $params['size'] = (int) specifies a max number of trained models to get (Default = 100)
328 * $params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb)
329 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
330 * $params['h'] = (list) Comma-separated list of column names to display
331 * $params['help'] = (boolean) Return help information (Default = false)
332 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
333 * $params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos)
334 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
336 * @param array $params Associative array of parameters
340 public function mlTrainedModels(array $params = [])
342 $model_id = $this->extractArgument($params, 'model_id');
346 $endpoint->setParams($params);
354 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
355 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
356 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
357 * $params['h'] = (list) Comma-separated list of column names to display
358 * $params['help'] = (boolean) Return help information (Default = false)
359 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
360 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
362 * @param array $params Associative array of parameters
366 public function nodeattrs(array $params = [])
371 $endpoint->setParams($params);
378 * $params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb)
379 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
380 * $params['full_id'] = (boolean) Return the full node ID instead of the shortened version (default: false)
381 * $params['local'] = (boolean) Calculate the selected nodes using the local cluster state rather than the state from master node (default: false)
382 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
383 * $params['h'] = (list) Comma-separated list of column names to display
384 * $params['help'] = (boolean) Return help information (Default = false)
385 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
386 * $params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos)
387 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
388 * $params['include_unloaded_segments'] = (boolean) If set to true segment stats will include stats for segments that are not currently loaded into memory (Default = false)
390 * @param array $params Associative array of parameters
394 public function nodes(array $params = [])
399 $endpoint->setParams($params);
406 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
407 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
408 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
409 * $params['h'] = (list) Comma-separated list of column names to display
410 * $params['help'] = (boolean) Return help information (Default = false)
411 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
412 * $params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos)
413 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
415 * @param array $params Associative array of parameters
419 public function pendingTasks(array $params = [])
424 $endpoint->setParams($params);
431 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
432 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
433 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
434 * $params['h'] = (list) Comma-separated list of column names to display
435 * $params['help'] = (boolean) Return help information (Default = false)
436 * $params['include_bootstrap'] = (boolean) Include bootstrap plugins in the response (Default = false)
437 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
438 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
440 * @param array $params Associative array of parameters
444 public function plugins(array $params = [])
449 $endpoint->setParams($params);
456 * $params['index'] = (list) Comma-separated list or wildcard expression of index names to limit the returned information
457 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
458 * $params['active_only'] = (boolean) If `true`, the response only includes ongoing shard recoveries (Default = false)
459 * $params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb)
460 * $params['detailed'] = (boolean) If `true`, the response includes detailed information about shard recoveries (Default = false)
461 * $params['h'] = (list) Comma-separated list of column names to display
462 * $params['help'] = (boolean) Return help information (Default = false)
463 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
464 * $params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos)
465 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
467 * @param array $params Associative array of parameters
471 public function recovery(array $params = [])
473 $index = $this->extractArgument($params, 'index');
477 $endpoint->setParams($params);
485 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
486 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (Default = false)
487 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
488 * $params['h'] = (list) Comma-separated list of column names to display
489 * $params['help'] = (boolean) Return help information (Default = false)
490 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
491 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
493 * @param array $params Associative array of parameters
497 public function repositories(array $params = [])
502 $endpoint->setParams($params);
509 * $params['index'] = (list) A comma-separated list of index names to limit the returned information
510 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
511 * $params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb)
512 * $params['h'] = (list) Comma-separated list of column names to display
513 * $params['help'] = (boolean) Return help information (Default = false)
514 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
515 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
517 * @param array $params Associative array of parameters
521 public function segments(array $params = [])
523 $index = $this->extractArgument($params, 'index');
527 $endpoint->setParams($params);
535 * $params['index'] = (list) A comma-separated list of index names to limit the returned information
536 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
537 * $params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb)
538 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
539 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
540 * $params['h'] = (list) Comma-separated list of column names to display
541 * $params['help'] = (boolean) Return help information (Default = false)
542 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
543 * $params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos)
544 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
546 * @param array $params Associative array of parameters
550 public function shards(array $params = [])
552 $index = $this->extractArgument($params, 'index');
556 $endpoint->setParams($params);
564 * $params['repository'] = (list) Name of repository from which to fetch the snapshot information
565 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
566 * $params['ignore_unavailable'] = (boolean) Set to true to ignore unavailable snapshots (Default = false)
567 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
568 * $params['h'] = (list) Comma-separated list of column names to display
569 * $params['help'] = (boolean) Return help information (Default = false)
570 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
571 * $params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos)
572 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
574 * @param array $params Associative array of parameters
578 public function snapshots(array $params = [])
580 $repository = $this->extractArgument($params, 'repository');
584 $endpoint->setParams($params);
592 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
593 * $params['nodes'] = (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
594 * $params['actions'] = (list) A comma-separated list of actions that should be returned. Leave empty to return all.
595 * $params['detailed'] = (boolean) Return detailed task information (default: false)
596 * $params['parent_task_id'] = (string) Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.
597 * $params['h'] = (list) Comma-separated list of column names to display
598 * $params['help'] = (boolean) Return help information (Default = false)
599 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
600 * $params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos)
601 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
603 * @param array $params Associative array of parameters
607 public function tasks(array $params = [])
612 $endpoint->setParams($params);
619 * $params['name'] = (string) A pattern that returned template names must match
620 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
621 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
622 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
623 * $params['h'] = (list) Comma-separated list of column names to display
624 * $params['help'] = (boolean) Return help information (Default = false)
625 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
626 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
628 * @param array $params Associative array of parameters
632 public function templates(array $params = [])
634 $name = $this->extractArgument($params, 'name');
638 $endpoint->setParams($params);
646 * $params['thread_pool_patterns'] = (list) A comma-separated list of regular-expressions to filter the thread pools in the output
647 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
648 * $params['size'] = (enum) The multiplier in which to display values (Options = ,k,m,g,t,p)
649 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
650 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
651 * $params['h'] = (list) Comma-separated list of column names to display
652 * $params['help'] = (boolean) Return help information (Default = false)
653 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
654 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
656 * @param array $params Associative array of parameters
660 public function threadPool(array $params = [])
662 $thread_pool_patterns = $this->extractArgument($params, 'thread_pool_patterns');
666 $endpoint->setParams($params);
674 * $params['transform_id'] = (string) The id of the transform for which to get stats. '_all' or '*' implies all transforms
675 * $params['from'] = (int) skips a number of transform configs, defaults to 0
676 * $params['size'] = (int) specifies a max number of transforms to get, defaults to 100
677 * $params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)
678 * $params['format'] = (string) a short version of the Accept header, e.g. json, yaml
679 * $params['h'] = (list) Comma-separated list of column names to display
680 * $params['help'] = (boolean) Return help information (Default = false)
681 * $params['s'] = (list) Comma-separated list of column names or column aliases to sort by
682 * $params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos)
683 * $params['v'] = (boolean) Verbose mode. Display column headers (Default = false)
685 * @param array $params Associative array of parameters
689 public function transforms(array $params = [])
691 $transform_id = $this->extractArgument($params, 'transform_id');
695 $endpoint->setParams($params);