Lines Matching refs:params

82     protected $params;
317 * $params['index'] = (string) Default index for items which don't provide one
318 * $params['type'] = DEPRECATED (string) Default document type for items which don't provide one
319 * $params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
320 * $params['refresh'] = (enum) If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (Options = true,false,wait_for)
321 * $params['routing'] = (string) Specific routing value
322 * $params['timeout'] = (time) Explicit operation timeout
323 * $params['_source'] = (list) True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request
324 * $params['_source_excludes'] = (list) Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
325 * $params['_source_includes'] = (list) Default list of fields to extract and return from the _source field, can be overridden on each sub-request
326 * $params['pipeline'] = (string) The pipeline id to preprocess incoming documents with
327 * $params['require_alias'] = (boolean) Sets require_alias for all incoming documents. Defaults to unset (false)
328 * $params['body'] = (array) The operation definition and data (action-data pairs), separated by newlines (Required)
330 * @param array $params Associative array of parameters
334 public function bulk(array $params = [])
336 $index = $this->extractArgument($params, 'index');
337 $type = $this->extractArgument($params, 'type');
338 $body = $this->extractArgument($params, 'body');
342 $endpoint->setParams($params);
352 * $params['scroll_id'] = DEPRECATED (list) A comma-separated list of scroll IDs to clear
353 * $params['body'] = (array) A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter
355 * @param array $params Associative array of parameters
359 public function clearScroll(array $params = [])
361 $scroll_id = $this->extractArgument($params, 'scroll_id');
362 $body = $this->extractArgument($params, 'body');
366 $endpoint->setParams($params);
375 * $params['body'] = (array) a point-in-time id to close
377 * @param array $params Associative array of parameters
381 public function closePointInTime(array $params = [])
383 $body = $this->extractArgument($params, 'body');
387 $endpoint->setParams($params);
395 * $params['index'] = (list) A comma-separated list of indices to restrict the results
396 * $params['type'] = DEPRECATED (list) A comma-separated list of types to restrict the results
397 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
398 * $params['ignore_throttled'] = (boolean) Whether specified concrete, expanded or aliased indices should be ignored when throttled
399 * $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)
400 * $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)
401 * $params['min_score'] = (number) Include only documents with a specific `_score` value in the result
402 * $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
403 * $params['routing'] = (list) A comma-separated list of specific routing values
404 * $params['q'] = (string) Query in the Lucene query string syntax
405 * $params['analyzer'] = (string) The analyzer to use for the query string
406 * $params['analyze_wildcard'] = (boolean) Specify whether wildcard and prefix queries should be analyzed (default: false)
407 * $params['default_operator'] = (enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR)
408 * $params['df'] = (string) The field to use as default where no field prefix is given in the query string
409 * $params['lenient'] = (boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
410 * $params['terminate_after'] = (number) The maximum count for each shard, upon reaching which the query execution will terminate early
411 * $params['body'] = (array) A query to restrict the results specified with the Query DSL (optional)
413 * @param array $params Associative array of parameters
417 public function count(array $params = [])
419 $index = $this->extractArgument($params, 'index');
420 $type = $this->extractArgument($params, 'type');
421 $body = $this->extractArgument($params, 'body');
425 $endpoint->setParams($params);
435 * $params['id'] = (string) Document ID (Required)
436 * $params['index'] = (string) The name of the index (Required)
437 * $params['type'] = DEPRECATED (string) The type of the document
438 * $params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
439 * $params['refresh'] = (enum) If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (Options = true,false,wait_for)
440 * $params['routing'] = (string) Specific routing value
441 * $params['timeout'] = (time) Explicit operation timeout
442 * $params['version'] = (number) Explicit version number for concurrency control
443 * $params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte)
444 * $params['pipeline'] = (string) The pipeline id to preprocess incoming documents with
445 * $params['body'] = (array) The document (Required)
447 * @param array $params Associative array of parameters
451 public function create(array $params = [])
453 $id = $this->extractArgument($params, 'id');
454 $index = $this->extractArgument($params, 'index');
455 $type = $this->extractArgument($params, 'type');
456 $body = $this->extractArgument($params, 'body');
460 $endpoint->setParams($params);
471 * $params['id'] = (string) The document ID (Required)
472 * $params['index'] = (string) The name of the index (Required)
473 * $params['type'] = DEPRECATED (string) The type of the document
474 * $params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the delete operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
475 * $params['refresh'] = (enum) If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (Options = true,false,wait_for)
476 * $params['routing'] = (string) Specific routing value
477 * $params['timeout'] = (time) Explicit operation timeout
478 * $params['if_seq_no'] = (number) only perform the delete operation if the last operation that has changed the document has the specified sequence number
479 * $params['if_primary_term'] = (number) only perform the delete operation if the last operation that has changed the document has the specified primary term
480 * $params['version'] = (number) Explicit version number for concurrency control
481 * $params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte,force)
483 * @param array $params Associative array of parameters
487 public function delete(array $params = [])
489 $id = $this->extractArgument($params, 'id');
490 $index = $this->extractArgument($params, 'index');
491 $type = $this->extractArgument($params, 'type');
495 $endpoint->setParams($params);
505 * $params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices (Required)
506 * $params['type'] = DEPRECATED (list) A comma-separated list of document types to search; leave empty to perform the operation on all types
507 * $params['analyzer'] = (string) The analyzer to use for the query string
508 * $params['analyze_wildcard'] = (boolean) Specify whether wildcard and prefix queries should be analyzed (default: false)
509 * $params['default_operator'] = (enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR)
510 * $params['df'] = (string) The field to use as default where no field prefix is given in the query string
511 * $params['from'] = (number) Starting offset (default: 0)
512 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
513 * $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)
514 * $params['conflicts'] = (enum) What to do when the delete by query hits version conflicts? (Options = abort,proceed) (Default = abort)
515 * $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)
516 * $params['lenient'] = (boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
517 * $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
518 * $params['q'] = (string) Query in the Lucene query string syntax
519 * $params['routing'] = (list) A comma-separated list of specific routing values
520 * $params['scroll'] = (time) Specify how long a consistent view of the index should be maintained for scrolled search
521 * $params['search_type'] = (enum) Search operation type (Options = query_then_fetch,dfs_query_then_fetch)
522 * $params['search_timeout'] = (time) Explicit timeout for each search request. Defaults to no timeout.
523 * $params['size'] = (number) Deprecated, please use `max_docs` instead
524 * $params['max_docs'] = (number) Maximum number of documents to process (default: all documents)
525 * $params['sort'] = (list) A comma-separated list of <field>:<direction> pairs
526 * $params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
527 * $params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
528 * $params['_source_includes'] = (list) A list of fields to extract and return from the _source field
529 * $params['terminate_after'] = (number) The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
530 * $params['stats'] = (list) Specific 'tag' of the request for logging and statistical purposes
531 * $params['version'] = (boolean) Specify whether to return document version as part of a hit
532 * $params['request_cache'] = (boolean) Specify if request cache should be used for this request or not, defaults to index level setting
533 * $params['refresh'] = (boolean) Should the effected indexes be refreshed?
534 * $params['timeout'] = (time) Time each individual bulk request should wait for shards that are unavailable. (Default = 1m)
535 * $params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
536 * $params['scroll_size'] = (number) Size on the scroll request powering the delete by query (Default = 100)
537 * $params['wait_for_completion'] = (boolean) Should the request should block until the delete by query is complete. (Default = true)
538 * $params['requests_per_second'] = (number) The throttle for this request in sub-requests per second. -1 means no throttle. (Default = 0)
539 * $params['slices'] = (number|string) The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`. (Default = 1)
540 * $params['body'] = (array) The search definition using the Query DSL (Required)
542 * @param array $params Associative array of parameters
546 public function deleteByQuery(array $params = [])
548 $index = $this->extractArgument($params, 'index');
549 $type = $this->extractArgument($params, 'type');
550 $body = $this->extractArgument($params, 'body');
554 $endpoint->setParams($params);
564 * $params['task_id'] = (string) The task id to rethrottle
565 * $params['requests_per_second'] = (number) The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (Required)
567 * @param array $params Associative array of parameters
571 public function deleteByQueryRethrottle(array $params = [])
573 $task_id = $this->extractArgument($params, 'task_id');
577 $endpoint->setParams($params);
585 * $params['id'] = (string) Script ID
586 * $params['timeout'] = (time) Explicit operation timeout
587 * $params['master_timeout'] = (time) Specify timeout for connection to master
589 * @param array $params Associative array of parameters
593 public function deleteScript(array $params = [])
595 $id = $this->extractArgument($params, 'id');
599 $endpoint->setParams($params);
607 * $params['id'] = (string) The document ID (Required)
608 * $params['index'] = (string) The name of the index (Required)
609 * $params['type'] = DEPRECATED (string) The type of the document (use `_all` to fetch the first document matching the ID across all types)
610 * $params['stored_fields'] = (list) A comma-separated list of stored fields to return in the response
611 * $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
612 * $params['realtime'] = (boolean) Specify whether to perform the operation in realtime or search mode
613 * $params['refresh'] = (boolean) Refresh the shard containing the document before performing the operation
614 * $params['routing'] = (string) Specific routing value
615 * $params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
616 * $params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
617 * $params['_source_includes'] = (list) A list of fields to extract and return from the _source field
618 * $params['version'] = (number) Explicit version number for concurrency control
619 * $params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte,force)
621 * @param array $params Associative array of parameters
625 public function exists(array $params = []): bool
627 $id = $this->extractArgument($params, 'id');
628 $index = $this->extractArgument($params, 'index');
629 $type = $this->extractArgument($params, 'type');
632 $params['client']['verbose'] = true;
636 $endpoint->setParams($params);
646 * $params['id'] = (string) The document ID (Required)
647 * $params['index'] = (string) The name of the index (Required)
648 * $params['type'] = DEPRECATED (string) The type of the document; deprecated and optional starting with 7.0
649 * $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
650 * $params['realtime'] = (boolean) Specify whether to perform the operation in realtime or search mode
651 * $params['refresh'] = (boolean) Refresh the shard containing the document before performing the operation
652 * $params['routing'] = (string) Specific routing value
653 * $params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
654 * $params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
655 * $params['_source_includes'] = (list) A list of fields to extract and return from the _source field
656 * $params['version'] = (number) Explicit version number for concurrency control
657 * $params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte,force)
659 * @param array $params Associative array of parameters
663 public function existsSource(array $params = []): bool
665 $id = $this->extractArgument($params, 'id');
666 $index = $this->extractArgument($params, 'index');
667 $type = $this->extractArgument($params, 'type');
670 $params['client']['verbose'] = true;
674 $endpoint->setParams($params);
684 * $params['id'] = (string) The document ID (Required)
685 * $params['index'] = (string) The name of the index (Required)
686 * $params['type'] = DEPRECATED (string) The type of the document
687 * $params['analyze_wildcard'] = (boolean) Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
688 * $params['analyzer'] = (string) The analyzer for the query string query
689 * $params['default_operator'] = (enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR)
690 * $params['df'] = (string) The default field for query string query (default: _all)
691 * $params['stored_fields'] = (list) A comma-separated list of stored fields to return in the response
692 * $params['lenient'] = (boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
693 * $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
694 * $params['q'] = (string) Query in the Lucene query string syntax
695 * $params['routing'] = (string) Specific routing value
696 * $params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
697 * $params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
698 * $params['_source_includes'] = (list) A list of fields to extract and return from the _source field
699 * $params['body'] = (array) The query definition using the Query DSL
701 * @param array $params Associative array of parameters
705 public function explain(array $params = [])
707 $id = $this->extractArgument($params, 'id');
708 $index = $this->extractArgument($params, 'index');
709 $type = $this->extractArgument($params, 'type');
710 $body = $this->extractArgument($params, 'body');
714 $endpoint->setParams($params);
725 * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
726 * $params['fields'] = (list) A comma-separated list of field names
727 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
728 * $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)
729 * $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)
730 * $params['include_unmapped'] = (boolean) Indicates whether unmapped fields should be included in the response. (Default = false)
731 * $params['body'] = (array) An index filter specified with the Query DSL
733 * @param array $params Associative array of parameters
737 public function fieldCaps(array $params = [])
739 $index = $this->extractArgument($params, 'index');
740 $body = $this->extractArgument($params, 'body');
744 $endpoint->setParams($params);
753 * $params['id'] = (string) The document ID (Required)
754 * $params['index'] = (string) The name of the index (Required)
755 * $params['type'] = DEPRECATED (string) The type of the document (use `_all` to fetch the first document matching the ID across all types)
756 * $params['stored_fields'] = (list) A comma-separated list of stored fields to return in the response
757 * $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
758 * $params['realtime'] = (boolean) Specify whether to perform the operation in realtime or search mode
759 * $params['refresh'] = (boolean) Refresh the shard containing the document before performing the operation
760 * $params['routing'] = (string) Specific routing value
761 * $params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
762 * $params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
763 * $params['_source_includes'] = (list) A list of fields to extract and return from the _source field
764 * $params['version'] = (number) Explicit version number for concurrency control
765 * $params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte,force)
767 * @param array $params Associative array of parameters
771 public function get(array $params = [])
773 $id = $this->extractArgument($params, 'id');
774 $index = $this->extractArgument($params, 'index');
775 $type = $this->extractArgument($params, 'type');
779 $endpoint->setParams($params);
789 * $params['id'] = (string) Script ID
790 * $params['master_timeout'] = (time) Specify timeout for connection to master
792 * @param array $params Associative array of parameters
796 public function getScript(array $params = [])
798 $id = $this->extractArgument($params, 'id');
802 $endpoint->setParams($params);
811 * @param array $params Associative array of parameters
818 public function getScriptContext(array $params = [])
823 $endpoint->setParams($params);
831 * @param array $params Associative array of parameters
838 public function getScriptLanguages(array $params = [])
843 $endpoint->setParams($params);
850 * $params['id'] = (string) The document ID (Required)
851 * $params['index'] = (string) The name of the index (Required)
852 * $params['type'] = DEPRECATED (string) The type of the document; deprecated and optional starting with 7.0
853 * $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
854 * $params['realtime'] = (boolean) Specify whether to perform the operation in realtime or search mode
855 * $params['refresh'] = (boolean) Refresh the shard containing the document before performing the operation
856 * $params['routing'] = (string) Specific routing value
857 * $params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
858 * $params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
859 * $params['_source_includes'] = (list) A list of fields to extract and return from the _source field
860 * $params['version'] = (number) Explicit version number for concurrency control
861 * $params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte,force)
863 * @param array $params Associative array of parameters
867 public function getSource(array $params = [])
869 $id = $this->extractArgument($params, 'id');
870 $index = $this->extractArgument($params, 'index');
871 $type = $this->extractArgument($params, 'type');
875 $endpoint->setParams($params);
885 * $params['id'] = (string) Document ID
886 * $params['index'] = (string) The name of the index (Required)
887 * $params['type'] = DEPRECATED (string) The type of the document
888 * $params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
889 * $params['op_type'] = (enum) Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID (Options = index,create)
890 * $params['refresh'] = (enum) If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (Options = true,false,wait_for)
891 * $params['routing'] = (string) Specific routing value
892 * $params['timeout'] = (time) Explicit operation timeout
893 * $params['version'] = (number) Explicit version number for concurrency control
894 * $params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte)
895 * $params['if_seq_no'] = (number) only perform the index operation if the last operation that has changed the document has the specified sequence number
896 * $params['if_primary_term'] = (number) only perform the index operation if the last operation that has changed the document has the specified primary term
897 * $params['pipeline'] = (string) The pipeline id to preprocess incoming documents with
898 * $params['require_alias'] = (boolean) When true, requires destination to be an alias. Default is false
899 * $params['body'] = (array) The document (Required)
901 * @param array $params Associative array of parameters
905 public function index(array $params = [])
907 $id = $this->extractArgument($params, 'id');
908 $index = $this->extractArgument($params, 'index');
909 $type = $this->extractArgument($params, 'type');
910 $body = $this->extractArgument($params, 'body');
914 $endpoint->setParams($params);
926 * @param array $params Associative array of parameters
930 public function info(array $params = [])
935 $endpoint->setParams($params);
942 * $params['index'] = (string) The name of the index
943 * $params['type'] = DEPRECATED (string) The type of the document
944 * $params['stored_fields'] = (list) A comma-separated list of stored fields to return in the response
945 * $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
946 * $params['realtime'] = (boolean) Specify whether to perform the operation in realtime or search mode
947 * $params['refresh'] = (boolean) Refresh the shard containing the document before performing the operation
948 * $params['routing'] = (string) Specific routing value
949 * $params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
950 * $params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
951 * $params['_source_includes'] = (list) A list of fields to extract and return from the _source field
952 * $params['body'] = (array) Document identifiers; can be either `docs` (containing full document information) or `ids` (when index and type is provided in the URL. (Required)
954 * @param array $params Associative array of parameters
958 public function mget(array $params = [])
960 $index = $this->extractArgument($params, 'index');
961 $type = $this->extractArgument($params, 'type');
962 $body = $this->extractArgument($params, 'body');
966 $endpoint->setParams($params);
976 * $params['index'] = (list) A comma-separated list of index names to use as default
977 * $params['type'] = DEPRECATED (list) A comma-separated list of document types to use as default
978 * $params['search_type'] = (enum) Search operation type (Options = query_then_fetch,dfs_query_then_fetch)
979 * $params['max_concurrent_searches'] = (number) Controls the maximum number of concurrent searches the multi search api will execute
980 * $params['typed_keys'] = (boolean) Specify whether aggregation and suggester names should be prefixed by their respective types in the response
981 * $params['pre_filter_shard_size'] = (number) A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
982 * $params['max_concurrent_shard_requests'] = (number) The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests (Default = 5)
983 * $params['rest_total_hits_as_int'] = (boolean) Indicates whether hits.total should be rendered as an integer or an object in the rest search response (Default = false)
984 * $params['ccs_minimize_roundtrips'] = (boolean) Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution (Default = true)
985 * $params['body'] = (array) The request definitions (metadata-search request definition pairs), separated by newlines (Required)
987 * @param array $params Associative array of parameters
991 public function msearch(array $params = [])
993 $index = $this->extractArgument($params, 'index');
994 $type = $this->extractArgument($params, 'type');
995 $body = $this->extractArgument($params, 'body');
999 $endpoint->setParams($params);
1009 * $params['index'] = (list) A comma-separated list of index names to use as default
1010 * $params['type'] = DEPRECATED (list) A comma-separated list of document types to use as default
1011 * $params['search_type'] = (enum) Search operation type (Options = query_then_fetch,dfs_query_then_fetch)
1012 * $params['typed_keys'] = (boolean) Specify whether aggregation and suggester names should be prefixed by their respective types in the response
1013 * $params['max_concurrent_searches'] = (number) Controls the maximum number of concurrent searches the multi search api will execute
1014 * $params['rest_total_hits_as_int'] = (boolean) Indicates whether hits.total should be rendered as an integer or an object in the rest search response (Default = false)
1015 * $params['ccs_minimize_roundtrips'] = (boolean) Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution (Default = true)
1016 * $params['body'] = (array) The request definitions (metadata-search request definition pairs), separated by newlines (Required)
1018 * @param array $params Associative array of parameters
1022 public function msearchTemplate(array $params = [])
1024 $index = $this->extractArgument($params, 'index');
1025 $type = $this->extractArgument($params, 'type');
1026 $body = $this->extractArgument($params, 'body');
1030 $endpoint->setParams($params);
1040 * $params['index'] = (string) The index in which the document resides.
1041 * $params['type'] = DEPRECATED (string) The type of the document.
1042 * $params['ids'] = (list) A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
1043 * $params['term_statistics'] = (boolean) Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". (Default = false)
1044 * $params['field_statistics'] = (boolean) Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". (Default = true)
1045 * $params['fields'] = (list) A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body "params" or "docs".
1046 * $params['offsets'] = (boolean) Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". (Default = true)
1047 * $params['positions'] = (boolean) Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". (Default = true)
1048 * $params['payloads'] = (boolean) Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". (Default = true)
1049 * $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body "params" or "docs".
1050 * $params['routing'] = (string) Specific routing value. Applies to all returned documents unless otherwise specified in body "params" or "docs".
1051 * $params['realtime'] = (boolean) Specifies if requests are real-time as opposed to near-real-time (default: true).
1052 * $params['version'] = (number) Explicit version number for concurrency control
1053 * $params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte,force)
1054 * $params['body'] = (array) Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.
1056 * @param array $params Associative array of parameters
1060 public function mtermvectors(array $params = [])
1062 $index = $this->extractArgument($params, 'index');
1063 $type = $this->extractArgument($params, 'type');
1064 $body = $this->extractArgument($params, 'body');
1068 $endpoint->setParams($params);
1078 * $params['index'] = (list) A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices
1079 * $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
1080 * $params['routing'] = (string) Specific routing value
1081 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
1082 * $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)
1083 * $params['keep_alive'] = (string) Specific the time to live for the point in time
1085 * @param array $params Associative array of parameters
1089 public function openPointInTime(array $params = [])
1091 $index = $this->extractArgument($params, 'index');
1095 $endpoint->setParams($params);
1104 * @param array $params Associative array of parameters
1108 public function ping(array $params = []): bool
1112 $params['client']['verbose'] = true;
1116 $endpoint->setParams($params);
1123 * $params['id'] = (string) Script ID (Required)
1124 * $params['context'] = (string) Script context
1125 * $params['timeout'] = (time) Explicit operation timeout
1126 * $params['master_timeout'] = (time) Specify timeout for connection to master
1127 * $params['body'] = (array) The document (Required)
1129 * @param array $params Associative array of parameters
1133 public function putScript(array $params = [])
1135 $id = $this->extractArgument($params, 'id');
1136 $context = $this->extractArgument($params, 'context');
1137 $body = $this->extractArgument($params, 'body');
1141 $endpoint->setParams($params);
1151 * $params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
1152 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
1153 * $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)
1154 * $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)
1155 * $params['search_type'] = (enum) Search operation type (Options = query_then_fetch,dfs_query_then_fetch)
1156 * $params['body'] = (array) The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. (Required)
1158 * @param array $params Associative array of parameters
1165 public function rankEval(array $params = [])
1167 $index = $this->extractArgument($params, 'index');
1168 $body = $this->extractArgument($params, 'body');
1172 $endpoint->setParams($params);
1181 * $params['refresh'] = (boolean) Should the affected indexes be refreshed?
1182 * $params['timeout'] = (time) Time each individual bulk request should wait for shards that are unavailable. (Default = 1m)
1183 * $params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the reindex operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
1184 * $params['wait_for_completion'] = (boolean) Should the request should block until the reindex is complete. (Default = true)
1185 * $params['requests_per_second'] = (number) The throttle to set on this request in sub-requests per second. -1 means no throttle. (Default = 0)
1186 * $params['scroll'] = (time) Control how long to keep the search context alive (Default = 5m)
1187 * $params['slices'] = (number|string) The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`. (Default = 1)
1188 * $params['max_docs'] = (number) Maximum number of documents to process (default: all documents)
1189 * $params['body'] = (array) The search definition using the Query DSL and the prototype for the index request. (Required)
1191 * @param array $params Associative array of parameters
1195 public function reindex(array $params = [])
1197 $body = $this->extractArgument($params, 'body');
1201 $endpoint->setParams($params);
1209 * $params['task_id'] = (string) The task id to rethrottle
1210 * $params['requests_per_second'] = (number) The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (Required)
1212 * @param array $params Associative array of parameters
1216 public function reindexRethrottle(array $params = [])
1218 $task_id = $this->extractArgument($params, 'task_id');
1222 $endpoint->setParams($params);
1230 * $params['id'] = (string) The id of the stored search template
1231 * $params['body'] = (array) The search definition template and its params
1233 * @param array $params Associative array of parameters
1237 public function renderSearchTemplate(array $params = [])
1239 $id = $this->extractArgument($params, 'id');
1240 $body = $this->extractArgument($params, 'body');
1244 $endpoint->setParams($params);
1253 * $params['body'] = (array) The script to execute
1255 * @param array $params Associative array of parameters
1262 public function scriptsPainlessExecute(array $params = [])
1264 $body = $this->extractArgument($params, 'body');
1268 $endpoint->setParams($params);
1276 * $params['scroll_id'] = DEPRECATED (string) The scroll ID
1277 * $params['scroll'] = (time) Specify how long a consistent view of the index should be maintained for scrolled search
1278 * $params['rest_total_hits_as_int'] = (boolean) Indicates whether hits.total should be rendered as an integer or an object in the rest search response (Default = false)
1279 * $params['body'] = (array) The scroll ID if not passed by URL or query parameter.
1281 * @param array $params Associative array of parameters
1285 public function scroll(array $params = [])
1287 $scroll_id = $this->extractArgument($params, 'scroll_id');
1288 $body = $this->extractArgument($params, 'body');
1292 $endpoint->setParams($params);
1301 * $params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
1302 * $params['type'] = DEPRECATED (list) A comma-separated list of document types to search; leave empty to perform the operation on all types
1303 * $params['analyzer'] = (string) The analyzer to use for the query string
1304 * $params['analyze_wildcard'] = (boolean) Specify whether wildcard and prefix queries should be analyzed (default: false)
1305 * $params['ccs_minimize_roundtrips'] = (boolean) Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution (Default = true)
1306 * $params['default_operator'] = (enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR)
1307 * $params['df'] = (string) The field to use as default where no field prefix is given in the query string
1308 * $params['explain'] = (boolean) Specify whether to return detailed information about score computation as part of a hit
1309 * $params['stored_fields'] = (list) A comma-separated list of stored fields to return as part of a hit
1310 * $params['docvalue_fields'] = (list) A comma-separated list of fields to return as the docvalue representation of a field for each hit
1311 * $params['from'] = (number) Starting offset (default: 0)
1312 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
1313 * $params['ignore_throttled'] = (boolean) Whether specified concrete, expanded or aliased indices should be ignored when throttled
1314 * $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)
1315 * $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)
1316 * $params['lenient'] = (boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
1317 * $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
1318 * $params['q'] = (string) Query in the Lucene query string syntax
1319 * $params['routing'] = (list) A comma-separated list of specific routing values
1320 * $params['scroll'] = (time) Specify how long a consistent view of the index should be maintained for scrolled search
1321 * $params['search_type'] = (enum) Search operation type (Options = query_then_fetch,dfs_query_then_fetch)
1322 * $params['size'] = (number) Number of hits to return (default: 10)
1323 * $params['sort'] = (list) A comma-separated list of <field>:<direction> pairs
1324 * $params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
1325 * $params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
1326 * $params['_source_includes'] = (list) A list of fields to extract and return from the _source field
1327 * $params['terminate_after'] = (number) The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
1328 * $params['stats'] = (list) Specific 'tag' of the request for logging and statistical purposes
1329 * $params['suggest_field'] = (string) Specify which field to use for suggestions
1330 * $params['suggest_mode'] = (enum) Specify suggest mode (Options = missing,popular,always) (Default = missing)
1331 * $params['suggest_size'] = (number) How many suggestions to return in response
1332 * $params['suggest_text'] = (string) The source text for which the suggestions should be returned
1333 * $params['timeout'] = (time) Explicit operation timeout
1334 * $params['track_scores'] = (boolean) Whether to calculate and return scores even if they are not used for sorting
1335 * $params['track_total_hits'] = (boolean) Indicate if the number of documents that match the query should be tracked
1336 * $params['allow_partial_search_results'] = (boolean) Indicate if an error should be returned if there is a partial search failure or timeout (Default = true)
1337 * $params['typed_keys'] = (boolean) Specify whether aggregation and suggester names should be prefixed by their respective types in the response
1338 * $params['version'] = (boolean) Specify whether to return document version as part of a hit
1339 * $params['seq_no_primary_term'] = (boolean) Specify whether to return sequence number and primary term of the last modification of each hit
1340 * $params['request_cache'] = (boolean) Specify if request cache should be used for this request or not, defaults to index level setting
1341 * $params['batched_reduce_size'] = (number) The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. (Default = 512)
1342 * $params['max_concurrent_shard_requests'] = (number) The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests (Default = 5)
1343 * $params['pre_filter_shard_size'] = (number) A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
1344 * $params['rest_total_hits_as_int'] = (boolean) Indicates whether hits.total should be rendered as an integer or an object in the rest search response (Default = false)
1345 * $params['min_compatible_shard_node'] = (string) The minimum compatible version that all shards involved in search should have for this request to be successful
1346 * $params['body'] = (array) The search definition using the Query DSL
1348 * @param array $params Associative array of parameters
1352 public function search(array $params = [])
1354 $index = $this->extractArgument($params, 'index');
1355 $type = $this->extractArgument($params, 'type');
1356 $body = $this->extractArgument($params, 'body');
1360 $endpoint->setParams($params);
1370 * $params['index'] = (list) Comma-separated list of data streams, indices, or aliases to search
1371 * $params['field'] = (string) Field containing geospatial data to return
1372 * $params['zoom'] = (int) Zoom level for the vector tile to search
1373 * $params['x'] = (int) X coordinate for the vector tile to search
1374 * $params['y'] = (int) Y coordinate for the vector tile to search
1375 * $params['exact_bounds'] = (boolean) If false, the meta layer's feature is the bounding box of the tile. If true, the meta layer's feature is a bounding box resulting from a `geo_bounds` aggregation. (Default = false)
1376 * $params['extent'] = (int) Size, in pixels, of a side of the vector tile. (Default = 4096)
1377 * $params['grid_precision'] = (int) Additional zoom levels available through the aggs layer. Accepts 0-8. (Default = 8)
1378 * $params['grid_type'] = (enum) Determines the geometry type for features in the aggs layer. (Options = grid,point) (Default = grid)
1379 * $params['size'] = (int) Maximum number of features to return in the hits layer. Accepts 0-10000. (Default = 10000)
1380 * $params['body'] = (array) Search request body.
1382 * @param array $params Associative array of parameters
1389 public function searchMvt(array $params = [])
1391 $index = $this->extractArgument($params, 'index');
1392 $field = $this->extractArgument($params, 'field');
1393 $zoom = $this->extractArgument($params, 'zoom');
1394 $x = $this->extractArgument($params, 'x');
1395 $y = $this->extractArgument($params, 'y');
1396 $body = $this->extractArgument($params, 'body');
1400 $endpoint->setParams($params);
1413 * $params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
1414 * $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
1415 * $params['routing'] = (string) Specific routing value
1416 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
1417 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
1418 * $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)
1419 * $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)
1421 * @param array $params Associative array of parameters
1425 public function searchShards(array $params = [])
1427 $index = $this->extractArgument($params, 'index');
1431 $endpoint->setParams($params);
1439 * $params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
1440 * $params['type'] = DEPRECATED (list) A comma-separated list of document types to search; leave empty to perform the operation on all types
1441 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
1442 * $params['ignore_throttled'] = (boolean) Whether specified concrete, expanded or aliased indices should be ignored when throttled
1443 * $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)
1444 * $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)
1445 * $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
1446 * $params['routing'] = (list) A comma-separated list of specific routing values
1447 * $params['scroll'] = (time) Specify how long a consistent view of the index should be maintained for scrolled search
1448 * $params['search_type'] = (enum) Search operation type (Options = query_then_fetch,dfs_query_then_fetch)
1449 * $params['explain'] = (boolean) Specify whether to return detailed information about score computation as part of a hit
1450 * $params['profile'] = (boolean) Specify whether to profile the query execution
1451 * $params['typed_keys'] = (boolean) Specify whether aggregation and suggester names should be prefixed by their respective types in the response
1452 * $params['rest_total_hits_as_int'] = (boolean) Indicates whether hits.total should be rendered as an integer or an object in the rest search response (Default = false)
1453 * $params['ccs_minimize_roundtrips'] = (boolean) Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution (Default = true)
1454 * $params['body'] = (array) The search definition template and its params (Required)
1456 * @param array $params Associative array of parameters
1460 public function searchTemplate(array $params = [])
1462 $index = $this->extractArgument($params, 'index');
1463 $type = $this->extractArgument($params, 'type');
1464 $body = $this->extractArgument($params, 'body');
1468 $endpoint->setParams($params);
1478 * $params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
1479 * $params['body'] = (array) field name, string which is the prefix expected in matching terms, timeout and size for max number of results
1481 * @param array $params Associative array of parameters
1488 public function termsEnum(array $params = [])
1490 $index = $this->extractArgument($params, 'index');
1491 $body = $this->extractArgument($params, 'body');
1495 $endpoint->setParams($params);
1504 * $params['index'] = (string) The index in which the document resides. (Required)
1505 * $params['id'] = (string) The id of the document, when not specified a doc param should be supplied.
1506 * $params['type'] = DEPRECATED (string) The type of the document.
1507 * $params['term_statistics'] = (boolean) Specifies if total term frequency and document frequency should be returned. (Default = false)
1508 * $params['field_statistics'] = (boolean) Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. (Default = true)
1509 * $params['fields'] = (list) A comma-separated list of fields to return.
1510 * $params['offsets'] = (boolean) Specifies if term offsets should be returned. (Default = true)
1511 * $params['positions'] = (boolean) Specifies if term positions should be returned. (Default = true)
1512 * $params['payloads'] = (boolean) Specifies if term payloads should be returned. (Default = true)
1513 * $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random).
1514 * $params['routing'] = (string) Specific routing value.
1515 * $params['realtime'] = (boolean) Specifies if request is real-time as opposed to near-real-time (default: true).
1516 * $params['version'] = (number) Explicit version number for concurrency control
1517 * $params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte,force)
1518 * $params['body'] = (array) Define parameters and or supply a document to get termvectors for. See documentation.
1520 * @param array $params Associative array of parameters
1524 public function termvectors(array $params = [])
1526 $index = $this->extractArgument($params, 'index');
1527 $id = $this->extractArgument($params, 'id');
1528 $type = $this->extractArgument($params, 'type');
1529 $body = $this->extractArgument($params, 'body');
1533 $endpoint->setParams($params);
1544 * $params['id'] = (string) Document ID (Required)
1545 * $params['index'] = (string) The name of the index (Required)
1546 * $params['type'] = DEPRECATED (string) The type of the document
1547 * $params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the update operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
1548 * $params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
1549 * $params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
1550 * $params['_source_includes'] = (list) A list of fields to extract and return from the _source field
1551 * $params['lang'] = (string) The script language (default: painless)
1552 * $params['refresh'] = (enum) If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (Options = true,false,wait_for)
1553 * $params['retry_on_conflict'] = (number) Specify how many times should the operation be retried when a conflict occurs (default: 0)
1554 * $params['routing'] = (string) Specific routing value
1555 * $params['timeout'] = (time) Explicit operation timeout
1556 * $params['if_seq_no'] = (number) only perform the update operation if the last operation that has changed the document has the specified sequence number
1557 * $params['if_primary_term'] = (number) only perform the update operation if the last operation that has changed the document has the specified primary term
1558 * $params['require_alias'] = (boolean) When true, requires destination is an alias. Default is false
1559 * $params['body'] = (array) The request definition requires either `script` or partial `doc` (Required)
1561 * @param array $params Associative array of parameters
1565 public function update(array $params = [])
1567 $id = $this->extractArgument($params, 'id');
1568 $index = $this->extractArgument($params, 'index');
1569 $type = $this->extractArgument($params, 'type');
1570 $body = $this->extractArgument($params, 'body');
1574 $endpoint->setParams($params);
1585 * $params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices (Required)
1586 * $params['type'] = DEPRECATED (list) A comma-separated list of document types to search; leave empty to perform the operation on all types
1587 * $params['analyzer'] = (string) The analyzer to use for the query string
1588 * $params['analyze_wildcard'] = (boolean) Specify whether wildcard and prefix queries should be analyzed (default: false)
1589 * $params['default_operator'] = (enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR)
1590 * $params['df'] = (string) The field to use as default where no field prefix is given in the query string
1591 * $params['from'] = (number) Starting offset (default: 0)
1592 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
1593 * $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)
1594 * $params['conflicts'] = (enum) What to do when the update by query hits version conflicts? (Options = abort,proceed) (Default = abort)
1595 * $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)
1596 * $params['lenient'] = (boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
1597 * $params['pipeline'] = (string) Ingest pipeline to set on index requests made by this action. (default: none)
1598 * $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
1599 * $params['q'] = (string) Query in the Lucene query string syntax
1600 * $params['routing'] = (list) A comma-separated list of specific routing values
1601 * $params['scroll'] = (time) Specify how long a consistent view of the index should be maintained for scrolled search
1602 * $params['search_type'] = (enum) Search operation type (Options = query_then_fetch,dfs_query_then_fetch)
1603 * $params['search_timeout'] = (time) Explicit timeout for each search request. Defaults to no timeout.
1604 * $params['size'] = (number) Deprecated, please use `max_docs` instead
1605 * $params['max_docs'] = (number) Maximum number of documents to process (default: all documents)
1606 * $params['sort'] = (list) A comma-separated list of <field>:<direction> pairs
1607 * $params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
1608 * $params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
1609 * $params['_source_includes'] = (list) A list of fields to extract and return from the _source field
1610 * $params['terminate_after'] = (number) The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
1611 * $params['stats'] = (list) Specific 'tag' of the request for logging and statistical purposes
1612 * $params['version'] = (boolean) Specify whether to return document version as part of a hit
1613 * $params['version_type'] = (boolean) Should the document increment the version number (internal) on hit or not (reindex)
1614 * $params['request_cache'] = (boolean) Specify if request cache should be used for this request or not, defaults to index level setting
1615 * $params['refresh'] = (boolean) Should the affected indexes be refreshed?
1616 * $params['timeout'] = (time) Time each individual bulk request should wait for shards that are unavailable. (Default = 1m)
1617 * $params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
1618 * $params['scroll_size'] = (number) Size on the scroll request powering the update by query (Default = 100)
1619 * $params['wait_for_completion'] = (boolean) Should the request should block until the update by query operation is complete. (Default = true)
1620 * $params['requests_per_second'] = (number) The throttle to set on this request in sub-requests per second. -1 means no throttle. (Default = 0)
1621 * $params['slices'] = (number|string) The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`. (Default = 1)
1622 * $params['body'] = (array) The search definition using the Query DSL
1624 * @param array $params Associative array of parameters
1628 public function updateByQuery(array $params = [])
1630 $index = $this->extractArgument($params, 'index');
1631 $type = $this->extractArgument($params, 'type');
1632 $body = $this->extractArgument($params, 'body');
1636 $endpoint->setParams($params);
1646 * $params['task_id'] = (string) The task id to rethrottle
1647 * $params['requests_per_second'] = (number) The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (Required)
1649 * @param array $params Associative array of parameters
1653 public function updateByQueryRethrottle(array $params = [])
1655 $task_id = $this->extractArgument($params, 'task_id');
1659 $endpoint->setParams($params);
1922 public function extractArgument(array &$params, string $arg)
1924 if (array_key_exists($arg, $params) === true) {
1925 $value = $params[$arg];
1929 unset($params[$arg]);