Lines Matching defs:params

33      * $params['index']              = (list) A comma separated list of indices to add a block to
34 * $params['block'] = (string) The block to add (one of read, write, read_only or metadata)
35 * $params['timeout'] = (time) Explicit operation timeout
36 * $params['master_timeout'] = (time) Specify timeout for connection to master
37 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
38 * $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)
39 * $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)
41 * @param array $params Associative array of parameters
45 public function addBlock(array $params = [])
47 $index = $this->extractArgument($params, 'index');
48 $block = $this->extractArgument($params, 'block');
52 $endpoint->setParams($params);
61 * $params['index'] = (string) The name of the index to scope the operation
62 * $params['body'] = (array) Define analyzer/tokenizer parameters and the text on which the analysis should be performed
64 * @param array $params Associative array of parameters
68 public function analyze(array $params = [])
70 $index = $this->extractArgument($params, 'index');
71 $body = $this->extractArgument($params, 'body');
75 $endpoint->setParams($params);
84 * $params['index'] = (list) A comma-separated list of index name to limit the operation
85 * $params['fielddata'] = (boolean) Clear field data
86 * $params['fields'] = (list) A comma-separated list of fields to clear when using the `fielddata` parameter (default: all)
87 * $params['query'] = (boolean) Clear query caches
88 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
89 * $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)
90 * $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)
91 * $params['request'] = (boolean) Clear request cache
93 * @param array $params Associative array of parameters
97 public function clearCache(array $params = [])
99 $index = $this->extractArgument($params, 'index');
103 $endpoint->setParams($params);
111 * $params['index'] = (string) The name of the source index to clone
112 * $params['target'] = (string) The name of the target index to clone into
113 * $params['timeout'] = (time) Explicit operation timeout
114 * $params['master_timeout'] = (time) Specify timeout for connection to master
115 * $params['wait_for_active_shards'] = (string) Set the number of active shards to wait for on the cloned index before the operation returns.
116 * $params['body'] = (array) The configuration for the target index (`settings` and `aliases`)
118 * @param array $params Associative array of parameters
122 public function clone(array $params = [])
124 $index = $this->extractArgument($params, 'index');
125 $target = $this->extractArgument($params, 'target');
126 $body = $this->extractArgument($params, 'body');
130 $endpoint->setParams($params);
140 * $params['index'] = (list) A comma separated list of indices to close
141 * $params['timeout'] = (time) Explicit operation timeout
142 * $params['master_timeout'] = (time) Specify timeout for connection to master
143 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
144 * $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)
145 * $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)
146 * $params['wait_for_active_shards'] = (string) Sets the number of active shards to wait for before the operation returns. Set to `index-setting` to wait according to the index setting `index.write.wait_for_active_shards`, or `all` to wait for all shards, or an integer. Defaults to `0`.
148 * @param array $params Associative array of parameters
152 public function close(array $params = [])
154 $index = $this->extractArgument($params, 'index');
158 $endpoint->setParams($params);
166 * $params['index'] = (string) The name of the index
167 * $params['include_type_name'] = (boolean) Whether a type should be expected in the body of the mappings.
168 * $params['wait_for_active_shards'] = (string) Set the number of active shards to wait for before the operation returns.
169 * $params['timeout'] = (time) Explicit operation timeout
170 * $params['master_timeout'] = (time) Specify timeout for connection to master
171 * $params['body'] = (array) The configuration for the index (`settings` and `mappings`)
173 * @param array $params Associative array of parameters
177 public function create(array $params = [])
179 $index = $this->extractArgument($params, 'index');
180 $body = $this->extractArgument($params, 'body');
184 $endpoint->setParams($params);
193 * $params['name'] = (string) The name of the data stream
195 * @param array $params Associative array of parameters
199 public function createDataStream(array $params = [])
201 $name = $this->extractArgument($params, 'name');
205 $endpoint->setParams($params);
213 * $params['name'] = (list) A comma-separated list of data stream names; use `_all` or empty string to perform the operation on all data streams
215 * @param array $params Associative array of parameters
219 public function dataStreamsStats(array $params = [])
221 $name = $this->extractArgument($params, 'name');
225 $endpoint->setParams($params);
233 * $params['index'] = (list) A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
234 * $params['timeout'] = (time) Explicit operation timeout
235 * $params['master_timeout'] = (time) Specify timeout for connection to master
236 * $params['ignore_unavailable'] = (boolean) Ignore unavailable indexes (default: false)
237 * $params['allow_no_indices'] = (boolean) Ignore if a wildcard expression resolves to no concrete indices (default: false)
238 * $params['expand_wildcards'] = (enum) Whether wildcard expressions should get expanded to open, closed, or hidden indices (Options = open,closed,hidden,none,all) (Default = open,closed)
240 * @param array $params Associative array of parameters
244 public function delete(array $params = [])
246 $index = $this->extractArgument($params, 'index');
250 $endpoint->setParams($params);
258 * $params['index'] = (list) A comma-separated list of index names (supports wildcards); use `_all` for all indices (Required)
259 * $params['name'] = (list) A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. (Required)
260 * $params['timeout'] = (time) Explicit timestamp for the document
261 * $params['master_timeout'] = (time) Specify timeout for connection to master
263 * @param array $params Associative array of parameters
267 public function deleteAlias(array $params = [])
269 $index = $this->extractArgument($params, 'index');
270 $name = $this->extractArgument($params, 'name');
274 $endpoint->setParams($params);
283 * $params['name'] = (list) A comma-separated list of data streams to delete; use `*` to delete all data streams
284 * $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)
286 * @param array $params Associative array of parameters
290 public function deleteDataStream(array $params = [])
292 $name = $this->extractArgument($params, 'name');
296 $endpoint->setParams($params);
304 * $params['name'] = (string) The name of the template
305 * $params['timeout'] = (time) Explicit operation timeout
306 * $params['master_timeout'] = (time) Specify timeout for connection to master
308 * @param array $params Associative array of parameters
312 public function deleteIndexTemplate(array $params = [])
314 $name = $this->extractArgument($params, 'name');
318 $endpoint->setParams($params);
326 * $params['name'] = (string) The name of the template
327 * $params['timeout'] = (time) Explicit operation timeout
328 * $params['master_timeout'] = (time) Specify timeout for connection to master
330 * @param array $params Associative array of parameters
334 public function deleteTemplate(array $params = [])
336 $name = $this->extractArgument($params, 'name');
340 $endpoint->setParams($params);
348 * $params['index'] = (string) Comma-separated list of indices or data streams to analyze the disk usage
349 * $params['run_expensive_tasks'] = (boolean) Must be set to [true] in order for the task to be performed. Defaults to false.
350 * $params['flush'] = (boolean) Whether flush or not before analyzing the index disk usage. Defaults to true
351 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
352 * $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)
353 * $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)
355 * @param array $params Associative array of parameters
362 public function diskUsage(array $params = [])
364 $index = $this->extractArgument($params, 'index');
368 $endpoint->setParams($params);
376 * $params['index'] = (list) A comma-separated list of index names
377 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
378 * $params['ignore_unavailable'] = (boolean) Ignore unavailable indexes (default: false)
379 * $params['allow_no_indices'] = (boolean) Ignore if a wildcard expression resolves to no concrete indices (default: false)
380 * $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)
381 * $params['flat_settings'] = (boolean) Return settings in flat format (default: false)
382 * $params['include_defaults'] = (boolean) Whether to return all default setting for each of the indices. (Default = false)
384 * @param array $params Associative array of parameters
388 public function exists(array $params = []): bool
390 $index = $this->extractArgument($params, 'index');
393 $params['client']['verbose'] = true;
397 $endpoint->setParams($params);
405 * $params['name'] = (list) A comma-separated list of alias names to return (Required)
406 * $params['index'] = (list) A comma-separated list of index names to filter aliases
407 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
408 * $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)
409 * $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)
410 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
412 * @param array $params Associative array of parameters
416 public function existsAlias(array $params = []): bool
418 $name = $this->extractArgument($params, 'name');
419 $index = $this->extractArgument($params, 'index');
422 $params['client']['verbose'] = true;
426 $endpoint->setParams($params);
435 * $params['name'] = (string) The name of the template
436 * $params['flat_settings'] = (boolean) Return settings in flat format (default: false)
437 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
438 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
440 * @param array $params Associative array of parameters
444 public function existsIndexTemplate(array $params = []): bool
446 $name = $this->extractArgument($params, 'name');
449 $params['client']['verbose'] = true;
453 $endpoint->setParams($params);
461 * $params['name'] = (list) The comma separated names of the index templates
462 * $params['flat_settings'] = (boolean) Return settings in flat format (default: false)
463 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
464 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
466 * @param array $params Associative array of parameters
470 public function existsTemplate(array $params = []): bool
472 $name = $this->extractArgument($params, 'name');
475 $params['client']['verbose'] = true;
479 $endpoint->setParams($params);
487 * $params['index'] = (list) A comma-separated list of index names; use `_all` to check the types across all indices
488 * $params['type'] = DEPRECATED (list) A comma-separated list of document types to check
489 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
490 * $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)
491 * $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)
492 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
494 * @param array $params Associative array of parameters
498 public function existsType(array $params = []): bool
500 $index = $this->extractArgument($params, 'index');
501 $type = $this->extractArgument($params, 'type');
504 $params['client']['verbose'] = true;
508 $endpoint->setParams($params);
517 * $params['index'] = (string) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
518 * $params['fields'] = (list) A comma-separated list of fields to include in the stats if only a subset of fields should be returned (supports wildcards)
519 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
520 * $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)
521 * $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)
523 * @param array $params Associative array of parameters
530 public function fieldUsageStats(array $params = [])
532 $index = $this->extractArgument($params, 'index');
536 $endpoint->setParams($params);
544 * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string for all indices
545 * $params['force'] = (boolean) Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)
546 * $params['wait_if_ongoing'] = (boolean) If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running.
547 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
548 * $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)
549 * $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)
551 * @param array $params Associative array of parameters
555 public function flush(array $params = [])
557 $index = $this->extractArgument($params, 'index');
561 $endpoint->setParams($params);
569 * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string for all indices
570 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
571 * $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)
572 * $params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,none,all) (Default = open)
574 * @param array $params Associative array of parameters
578 public function flushSynced(array $params = [])
580 $index = $this->extractArgument($params, 'index');
584 $endpoint->setParams($params);
592 * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
593 * $params['flush'] = (boolean) Specify whether the index should be flushed after performing the operation (default: true)
594 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
595 * $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)
596 * $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)
597 * $params['max_num_segments'] = (number) The number of segments the index should be merged into (default: dynamic)
598 * $params['only_expunge_deletes'] = (boolean) Specify whether the operation should only expunge deleted documents
600 * @param array $params Associative array of parameters
604 public function forcemerge(array $params = [])
606 $index = $this->extractArgument($params, 'index');
610 $endpoint->setParams($params);
618 * $params['index'] = (string) The name of the index to freeze
619 * $params['timeout'] = (time) Explicit operation timeout
620 * $params['master_timeout'] = (time) Specify timeout for connection to master
621 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
622 * $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)
623 * $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)
624 * $params['wait_for_active_shards'] = (string) Sets the number of active shards to wait for before the operation returns.
626 * @param array $params Associative array of parameters
630 public function freeze(array $params = [])
632 $index = $this->extractArgument($params, 'index');
636 $endpoint->setParams($params);
644 * $params['index'] = (list) A comma-separated list of index names
645 * $params['include_type_name'] = (boolean) Whether to add the type name to the response (default: false)
646 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
647 * $params['ignore_unavailable'] = (boolean) Ignore unavailable indexes (default: false)
648 * $params['allow_no_indices'] = (boolean) Ignore if a wildcard expression resolves to no concrete indices (default: false)
649 * $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)
650 * $params['flat_settings'] = (boolean) Return settings in flat format (default: false)
651 * $params['include_defaults'] = (boolean) Whether to return all default setting for each of the indices. (Default = false)
652 * $params['master_timeout'] = (time) Specify timeout for connection to master
654 * @param array $params Associative array of parameters
658 public function get(array $params = [])
660 $index = $this->extractArgument($params, 'index');
664 $endpoint->setParams($params);
672 * $params['name'] = (list) A comma-separated list of alias names to return
673 * $params['index'] = (list) A comma-separated list of index names to filter aliases
674 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
675 * $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)
676 * $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)
677 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
679 * @param array $params Associative array of parameters
683 public function getAlias(array $params = [])
685 $name = $this->extractArgument($params, 'name');
686 $index = $this->extractArgument($params, 'index');
690 $endpoint->setParams($params);
699 * $params['name'] = (list) A comma-separated list of data streams to get; use `*` to get all data streams
700 * $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)
702 * @param array $params Associative array of parameters
706 public function getDataStream(array $params = [])
708 $name = $this->extractArgument($params, 'name');
712 $endpoint->setParams($params);
720 * $params['fields'] = (list) A comma-separated list of fields (Required)
721 * $params['index'] = (list) A comma-separated list of index names
722 * $params['type'] = DEPRECATED (list) A comma-separated list of document types
723 * $params['include_type_name'] = (boolean) Whether a type should be returned in the body of the mappings.
724 * $params['include_defaults'] = (boolean) Whether the default mapping values should be returned as well
725 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
726 * $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)
727 * $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)
728 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
730 * @param array $params Associative array of parameters
734 public function getFieldMapping(array $params = [])
736 $fields = $this->extractArgument($params, 'fields');
737 $index = $this->extractArgument($params, 'index');
738 $type = $this->extractArgument($params, 'type');
742 $endpoint->setParams($params);
752 * $params['name'] = (list) The comma separated names of the index templates
753 * $params['flat_settings'] = (boolean) Return settings in flat format (default: false)
754 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
755 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
757 * @param array $params Associative array of parameters
761 public function getIndexTemplate(array $params = [])
763 $name = $this->extractArgument($params, 'name');
767 $endpoint->setParams($params);
775 * $params['index'] = (list) A comma-separated list of index names
776 * $params['type'] = DEPRECATED (list) A comma-separated list of document types
777 * $params['include_type_name'] = (boolean) Whether to add the type name to the response (default: false)
778 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
779 * $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)
780 * $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)
781 * $params['master_timeout'] = (time) Specify timeout for connection to master
782 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
784 * @param array $params Associative array of parameters
788 public function getMapping(array $params = [])
790 $index = $this->extractArgument($params, 'index');
791 $type = $this->extractArgument($params, 'type');
795 $endpoint->setParams($params);
804 * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
805 * $params['name'] = (list) The name of the settings that should be included
806 * $params['master_timeout'] = (time) Specify timeout for connection to master
807 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
808 * $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)
809 * $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)
810 * $params['flat_settings'] = (boolean) Return settings in flat format (default: false)
811 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
812 * $params['include_defaults'] = (boolean) Whether to return all default setting for each of the indices. (Default = false)
814 * @param array $params Associative array of parameters
818 public function getSettings(array $params = [])
820 $index = $this->extractArgument($params, 'index');
821 $name = $this->extractArgument($params, 'name');
825 $endpoint->setParams($params);
834 * $params['name'] = (list) The comma separated names of the index templates
835 * $params['include_type_name'] = (boolean) Whether a type should be returned in the body of the mappings.
836 * $params['flat_settings'] = (boolean) Return settings in flat format (default: false)
837 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
838 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
840 * @param array $params Associative array of parameters
844 public function getTemplate(array $params = [])
846 $name = $this->extractArgument($params, 'name');
850 $endpoint->setParams($params);
858 * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
859 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
860 * $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)
861 * $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)
863 * @param array $params Associative array of parameters
867 public function getUpgrade(array $params = [])
869 $index = $this->extractArgument($params, 'index');
873 $endpoint->setParams($params);
881 * $params['name'] = (string) The name of the alias to migrate
883 * @param array $params Associative array of parameters
887 public function migrateToDataStream(array $params = [])
889 $name = $this->extractArgument($params, 'name');
893 $endpoint->setParams($params);
901 * $params['index'] = (list) A comma separated list of indices to open
902 * $params['timeout'] = (time) Explicit operation timeout
903 * $params['master_timeout'] = (time) Specify timeout for connection to master
904 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
905 * $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)
906 * $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)
907 * $params['wait_for_active_shards'] = (string) Sets the number of active shards to wait for before the operation returns.
909 * @param array $params Associative array of parameters
913 public function open(array $params = [])
915 $index = $this->extractArgument($params, 'index');
919 $endpoint->setParams($params);
927 * $params['name'] = (string) The name of the data stream
929 * @param array $params Associative array of parameters
933 public function promoteDataStream(array $params = [])
935 $name = $this->extractArgument($params, 'name');
939 $endpoint->setParams($params);
947 * $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)
948 * $params['name'] = (string) The name of the alias to be created or updated (Required)
949 * $params['timeout'] = (time) Explicit timestamp for the document
950 * $params['master_timeout'] = (time) Specify timeout for connection to master
951 * $params['body'] = (array) The settings for the alias, such as `routing` or `filter`
953 * @param array $params Associative array of parameters
957 public function putAlias(array $params = [])
959 $index = $this->extractArgument($params, 'index');
960 $name = $this->extractArgument($params, 'name');
961 $body = $this->extractArgument($params, 'body');
965 $endpoint->setParams($params);
975 * $params['name'] = (string) The name of the template
976 * $params['create'] = (boolean) Whether the index template should only be added if new or can also replace an existing one (Default = false)
977 * $params['cause'] = (string) User defined reason for creating/updating the index template (Default = )
978 * $params['master_timeout'] = (time) Specify timeout for connection to master
979 * $params['body'] = (array) The template definition (Required)
981 * @param array $params Associative array of parameters
985 public function putIndexTemplate(array $params = [])
987 $name = $this->extractArgument($params, 'name');
988 $body = $this->extractArgument($params, 'body');
992 $endpoint->setParams($params);
1001 * $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.
1002 * $params['type'] = DEPRECATED (string) The name of the document type
1003 * $params['include_type_name'] = (boolean) Whether a type should be expected in the body of the mappings.
1004 * $params['timeout'] = (time) Explicit operation timeout
1005 * $params['master_timeout'] = (time) Specify timeout for connection to master
1006 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
1007 * $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)
1008 * $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)
1009 * $params['write_index_only'] = (boolean) When true, applies mappings only to the write index of an alias or data stream (Default = false)
1010 * $params['body'] = (array) The mapping definition (Required)
1012 * @param array $params Associative array of parameters
1016 public function putMapping(array $params = [])
1018 $index = $this->extractArgument($params, 'index');
1019 $type = $this->extractArgument($params, 'type');
1020 $body = $this->extractArgument($params, 'body');
1024 $endpoint->setParams($params);
1034 * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
1035 * $params['master_timeout'] = (time) Specify timeout for connection to master
1036 * $params['timeout'] = (time) Explicit operation timeout
1037 * $params['preserve_existing'] = (boolean) Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false`
1038 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
1039 * $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)
1040 * $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)
1041 * $params['flat_settings'] = (boolean) Return settings in flat format (default: false)
1042 * $params['body'] = (array) The index settings to be updated (Required)
1044 * @param array $params Associative array of parameters
1048 public function putSettings(array $params = [])
1050 $index = $this->extractArgument($params, 'index');
1051 $body = $this->extractArgument($params, 'body');
1055 $endpoint->setParams($params);
1064 * $params['name'] = (string) The name of the template
1065 * $params['include_type_name'] = (boolean) Whether a type should be returned in the body of the mappings.
1066 * $params['order'] = (number) The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
1067 * $params['create'] = (boolean) Whether the index template should only be added if new or can also replace an existing one (Default = false)
1068 * $params['master_timeout'] = (time) Specify timeout for connection to master
1069 * $params['body'] = (array) The template definition (Required)
1071 * @param array $params Associative array of parameters
1075 public function putTemplate(array $params = [])
1077 $name = $this->extractArgument($params, 'name');
1078 $body = $this->extractArgument($params, 'body');
1082 $endpoint->setParams($params);
1091 * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
1092 * $params['detailed'] = (boolean) Whether to display detailed information about shard recovery (Default = false)
1093 * $params['active_only'] = (boolean) Display only those recoveries that are currently on-going (Default = false)
1095 * @param array $params Associative array of parameters
1099 public function recovery(array $params = [])
1101 $index = $this->extractArgument($params, 'index');
1105 $endpoint->setParams($params);
1113 * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
1114 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
1115 * $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)
1116 * $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)
1118 * @param array $params Associative array of parameters
1122 public function refresh(array $params = [])
1124 $index = $this->extractArgument($params, 'index');
1128 $endpoint->setParams($params);
1136 * $params['index'] = (list) A comma-separated list of index names to reload analyzers for
1137 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
1138 * $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)
1139 * $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)
1141 * @param array $params Associative array of parameters
1145 public function reloadSearchAnalyzers(array $params = [])
1147 $index = $this->extractArgument($params, 'index');
1151 $endpoint->setParams($params);
1159 * $params['name'] = (list) A comma-separated list of names or wildcard expressions
1160 * $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)
1162 * @param array $params Associative array of parameters
1169 public function resolveIndex(array $params = [])
1171 $name = $this->extractArgument($params, 'name');
1175 $endpoint->setParams($params);
1183 * $params['alias'] = (string) The name of the alias to rollover (Required)
1184 * $params['new_index'] = (string) The name of the rollover index
1185 * $params['include_type_name'] = (boolean) Whether a type should be included in the body of the mappings.
1186 * $params['timeout'] = (time) Explicit operation timeout
1187 * $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
1188 * $params['master_timeout'] = (time) Specify timeout for connection to master
1189 * $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.
1190 * $params['body'] = (array) The conditions that needs to be met for executing rollover
1192 * @param array $params Associative array of parameters
1196 public function rollover(array $params = [])
1198 $alias = $this->extractArgument($params, 'alias');
1199 $new_index = $this->extractArgument($params, 'new_index');
1200 $body = $this->extractArgument($params, 'body');
1204 $endpoint->setParams($params);
1214 * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
1215 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
1216 * $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)
1217 * $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)
1218 * $params['verbose'] = (boolean) Includes detailed memory usage by Lucene. (Default = false)
1220 * @param array $params Associative array of parameters
1224 public function segments(array $params = [])
1226 $index = $this->extractArgument($params, 'index');
1230 $endpoint->setParams($params);
1238 * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
1239 * $params['status'] = (list) A comma-separated list of statuses used to filter on shards to get store information for (Options = green,yellow,red,all)
1240 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
1241 * $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)
1242 * $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)
1244 * @param array $params Associative array of parameters
1248 public function shardStores(array $params = [])
1250 $index = $this->extractArgument($params, 'index');
1254 $endpoint->setParams($params);
1262 * $params['index'] = (string) The name of the source index to shrink
1263 * $params['target'] = (string) The name of the target index to shrink into
1264 * $params['copy_settings'] = (boolean) whether or not to copy settings from the source index (defaults to false)
1265 * $params['timeout'] = (time) Explicit operation timeout
1266 * $params['master_timeout'] = (time) Specify timeout for connection to master
1267 * $params['wait_for_active_shards'] = (string) Set the number of active shards to wait for on the shrunken index before the operation returns.
1268 * $params['body'] = (array) The configuration for the target index (`settings` and `aliases`)
1270 * @param array $params Associative array of parameters
1274 public function shrink(array $params = [])
1276 $index = $this->extractArgument($params, 'index');
1277 $target = $this->extractArgument($params, 'target');
1278 $body = $this->extractArgument($params, 'body');
1282 $endpoint->setParams($params);
1292 * $params['name'] = (string) The name of the index (it must be a concrete index name)
1293 * $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)
1294 * $params['cause'] = (string) User defined reason for dry-run creating the new template for simulation purposes (Default = )
1295 * $params['master_timeout'] = (time) Specify timeout for connection to master
1296 * $params['body'] = (array) New index template definition, which will be included in the simulation, as if it already exists in the system
1298 * @param array $params Associative array of parameters
1302 public function simulateIndexTemplate(array $params = [])
1304 $name = $this->extractArgument($params, 'name');
1305 $body = $this->extractArgument($params, 'body');
1309 $endpoint->setParams($params);
1318 * $params['name'] = (string) The name of the index template
1319 * $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)
1320 * $params['cause'] = (string) User defined reason for dry-run creating the new template for simulation purposes (Default = )
1321 * $params['master_timeout'] = (time) Specify timeout for connection to master
1322 * $params['body'] = (array) New index template definition to be simulated, if no index template name is specified
1324 * @param array $params Associative array of parameters
1328 public function simulateTemplate(array $params = [])
1330 $name = $this->extractArgument($params, 'name');
1331 $body = $this->extractArgument($params, 'body');
1335 $endpoint->setParams($params);
1344 * $params['index'] = (string) The name of the source index to split
1345 * $params['target'] = (string) The name of the target index to split into
1346 * $params['copy_settings'] = (boolean) whether or not to copy settings from the source index (defaults to false)
1347 * $params['timeout'] = (time) Explicit operation timeout
1348 * $params['master_timeout'] = (time) Specify timeout for connection to master
1349 * $params['wait_for_active_shards'] = (string) Set the number of active shards to wait for on the shrunken index before the operation returns.
1350 * $params['body'] = (array) The configuration for the target index (`settings` and `aliases`)
1352 * @param array $params Associative array of parameters
1356 public function split(array $params = [])
1358 $index = $this->extractArgument($params, 'index');
1359 $target = $this->extractArgument($params, 'target');
1360 $body = $this->extractArgument($params, 'body');
1364 $endpoint->setParams($params);
1374 * $params['metric'] = (list) Limit the information returned the specific metrics.
1375 * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
1376 * $params['completion_fields'] = (list) A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
1377 * $params['fielddata_fields'] = (list) A comma-separated list of fields for `fielddata` index metric (supports wildcards)
1378 * $params['fields'] = (list) A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
1379 * $params['groups'] = (list) A comma-separated list of search groups for `search` index metric
1380 * $params['level'] = (enum) Return stats aggregated at cluster, index or shard level (Options = cluster,indices,shards) (Default = indices)
1381 * $params['types'] = (list) A comma-separated list of document types for the `indexing` index metric
1382 * $params['include_segment_file_sizes'] = (boolean) Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested) (Default = false)
1383 * $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)
1384 * $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)
1385 * $params['forbid_closed_indices'] = (boolean) If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices (Default = true)
1387 * @param array $params Associative array of parameters
1391 public function stats(array $params = [])
1393 $metric = $this->extractArgument($params, 'metric');
1394 $index = $this->extractArgument($params, 'index');
1398 $endpoint->setParams($params);
1407 * $params['index'] = (string) The name of the index to unfreeze
1408 * $params['timeout'] = (time) Explicit operation timeout
1409 * $params['master_timeout'] = (time) Specify timeout for connection to master
1410 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
1411 * $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)
1412 * $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)
1413 * $params['wait_for_active_shards'] = (string) Sets the number of active shards to wait for before the operation returns.
1415 * @param array $params Associative array of parameters
1419 public function unfreeze(array $params = [])
1421 $index = $this->extractArgument($params, 'index');
1425 $endpoint->setParams($params);
1433 * $params['timeout'] = (time) Request timeout
1434 * $params['master_timeout'] = (time) Specify timeout for connection to master
1435 * $params['body'] = (array) The definition of `actions` to perform (Required)
1437 * @param array $params Associative array of parameters
1441 public function updateAliases(array $params = [])
1443 $body = $this->extractArgument($params, 'body');
1447 $endpoint->setParams($params);
1455 * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
1456 * $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)
1457 * $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)
1458 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
1459 * $params['wait_for_completion'] = (boolean) Specify whether the request should block until the all segments are upgraded (default: false)
1460 * $params['only_ancient_segments'] = (boolean) If true, only ancient (an older Lucene major release) segments will be upgraded
1462 * @param array $params Associative array of parameters
1466 public function upgrade(array $params = [])
1468 $index = $this->extractArgument($params, 'index');
1472 $endpoint->setParams($params);
1480 * $params['index'] = (list) A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
1481 * $params['type'] = DEPRECATED (list) A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
1482 * $params['explain'] = (boolean) Return detailed information about the error
1483 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
1484 * $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)
1485 * $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)
1486 * $params['q'] = (string) Query in the Lucene query string syntax
1487 * $params['analyzer'] = (string) The analyzer to use for the query string
1488 * $params['analyze_wildcard'] = (boolean) Specify whether wildcard and prefix queries should be analyzed (default: false)
1489 * $params['default_operator'] = (enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR)
1490 * $params['df'] = (string) The field to use as default where no field prefix is given in the query string
1491 * $params['lenient'] = (boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
1492 * $params['rewrite'] = (boolean) Provide a more detailed explanation showing the actual Lucene query that will be executed.
1493 * $params['all_shards'] = (boolean) Execute validation on all shards instead of one random shard per index
1494 * $params['body'] = (array) The query definition specified with the Query DSL
1496 * @param array $params Associative array of parameters
1500 public function validateQuery(array $params = [])
1502 $index = $this->extractArgument($params, 'index');
1503 $type = $this->extractArgument($params, 'type');
1504 $body = $this->extractArgument($params, 'body');
1508 $endpoint->setParams($params);
1521 public function getAliases(array $params = [])
1523 return $this->getAlias($params);