vendor/elasticsearch/elasticsearch/src/Elasticsearch/Client.php line 143

Open in your IDE?
  1. <?php
  3. declare(strict_types = 1);
  5. namespace Elasticsearch;
  7. use Elasticsearch\Common\Exceptions\BadMethodCallException;
  8. use Elasticsearch\Common\Exceptions\InvalidArgumentException;
  9. use Elasticsearch\Common\Exceptions\NoNodesAvailableException;
  10. use Elasticsearch\Common\Exceptions\BadRequest400Exception;
  11. use Elasticsearch\Common\Exceptions\Missing404Exception;
  12. use Elasticsearch\Common\Exceptions\TransportException;
  13. use Elasticsearch\Endpoints\AbstractEndpoint;
  14. use Elasticsearch\Namespaces\AbstractNamespace;
  15. use Elasticsearch\Namespaces\CatNamespace;
  16. use Elasticsearch\Namespaces\ClusterNamespace;
  17. use Elasticsearch\Namespaces\IndicesNamespace;
  18. use Elasticsearch\Namespaces\IngestNamespace;
  19. use Elasticsearch\Namespaces\NamespaceBuilderInterface;
  20. use Elasticsearch\Namespaces\NodesNamespace;
  21. use Elasticsearch\Namespaces\SnapshotNamespace;
  22. use Elasticsearch\Namespaces\BooleanRequestWrapper;
  23. use Elasticsearch\Namespaces\TasksNamespace;
  25. /**
  26.  * Class Client
  27.  *
  28.  * @category Elasticsearch
  29.  * @package  Elasticsearch
  30.  * @author   Zachary Tong <zach@elastic.co>
  31.  * @license  http://www.apache.org/licenses/LICENSE-2.0 Apache2
  32.  * @link     http://elastic.co
  33.  */
  34. class Client
  35. {
  36.     const VERSION = '7.2.2';
  38.     /**
  39.      * @var Transport
  40.      */
  41.     public $transport;
  43.     /**
  44.      * @var array
  45.      */
  46.     protected $params;
  48.     /**
  49.      * @var IndicesNamespace
  50.      */
  51.     protected $indices;
  53.     /**
  54.      * @var ClusterNamespace
  55.      */
  56.     protected $cluster;
  58.     /**
  59.      * @var NodesNamespace
  60.      */
  61.     protected $nodes;
  63.     /**
  64.      * @var SnapshotNamespace
  65.      */
  66.     protected $snapshot;
  68.     /**
  69.      * @var CatNamespace
  70.      */
  71.     protected $cat;
  73.     /**
  74.      * @var IngestNamespace
  75.      */
  76.     protected $ingest;
  78.     /**
  79.      * @var TasksNamespace
  80.      */
  81.     protected $tasks;
  83.     /**
  84.      * @var callable
  85.      */
  86.     protected $endpoints;
  88.     /**
  89.      * @var NamespaceBuilderInterface[]
  90.      */
  91.     protected $registeredNamespaces = [];
  93.     /**
  94.      * Client constructor
  95.      *
  96.      * @param Transport           $transport
  97.      * @param callable            $endpoint
  98.      * @param AbstractNamespace[] $registeredNamespaces
  99.      */
  100.     public function __construct(Transport $transport, callable $endpoint, array $registeredNamespaces)
  101.     {
  102.         $this->transport = $transport;
  103.         $this->endpoints = $endpoint;
  104.         $this->indices   = new IndicesNamespace($transport, $endpoint);
  105.         $this->cluster   = new ClusterNamespace($transport, $endpoint);
  106.         $this->nodes     = new NodesNamespace($transport, $endpoint);
  107.         $this->snapshot  = new SnapshotNamespace($transport, $endpoint);
  108.         $this->cat       = new CatNamespace($transport, $endpoint);
  109.         $this->ingest    = new IngestNamespace($transport, $endpoint);
  110.         $this->tasks     = new TasksNamespace($transport, $endpoint);
  111.         $this->registeredNamespaces = $registeredNamespaces;
  112.     }
  114.     /**
  115.      * Endpoint: info
  116.      *
  117.      * @see http://www.elastic.co/guide/
  118.      *
  119.      * @return callable|array
  120.      */
  121.     public function info(array $params = [])
  122.     {
  123.         /**
  124.  * @var callable $endpointBuilder
  125. */
  126.         $endpointBuilder = $this->endpoints;
  128.         /**
  129.  * @var \Elasticsearch\Endpoints\Info $endpoint
  130. */
  131.         $endpoint = $endpointBuilder('Info');
  132.         $endpoint->setParams($params);
  134.         return $this->performRequest($endpoint);
  135.     }
  137.     /**
  138.      * Endpoint: ping
  139.      *
  140.      * @see http://www.elastic.co/guide/
  141.      *
  142.      */
  143.     public function ping(array $params = []): bool
  144.     {
  145.         /**
  146.  * @var callable $endpointBuilder
  147. */
  148.         $endpointBuilder = $this->endpoints;
  150.         /**
  151.  * @var \Elasticsearch\Endpoints\Ping $endpoint
  152. */
  153.         $endpoint = $endpointBuilder('Ping');
  154.         $endpoint->setParams($params);
  156.         try {
  157.             $this->performRequest($endpoint);
  158.         } catch (Missing404Exception $exception) {
  159.             return false;
  160.         } catch (TransportException $exception) {
  161.             return false;
  162.         } catch (NoNodesAvailableException $exception) {
  163.             return false;
  164.         }
  166.         return true;
  167.     }
  169.     /**
  170.      * Endpoint: rank_eval
  171.      *
  172.      * @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html
  173.      *
  174.      * $params[
  175.      *   'body'               => '(string) The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. (Required)',
  176.      *   'index'              => '(list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices',
  177.      *   'ignore_unavailable' => '(boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)',
  178.      *   '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)',
  179.      *   'expand_wildcards'   => '(enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,none,all) (Default = open)',
  180.      * ]
  181.      * @return callable|array
  182.      */
  183.     public function rankEval(array $params)
  184.     {
  185.         $body = $this->extractArgument($params, 'body');
  186.         $index = $this->extractArgument($params, 'index');
  188.         /**
  189.  * @var callable $endpointBuilder
  190. */
  191.         $endpointBuilder = $this->endpoints;
  193.         /**
  194.  * @var \Elasticsearch\Endpoints\RankEval $endpoint
  195. */
  196.         $endpoint = $endpointBuilder('RankEval');
  197.         $endpoint->setBody($body)
  198.             ->setIndex($index);
  199.         $endpoint->setParams($params);
  201.         return $this->performRequest($endpoint);
  202.     }
  204.     /**
  205.      * Endpoint: get
  206.      *
  207.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html
  208.      *
  209.      * $params[
  210.      *   'id'               => '(string) The document ID (Required)',
  211.      *   'index'            => '(string) The name of the index (Required)',
  212.      *   'type'             => '(string) The type of the document (use `_all` to fetch the first document matching the ID across all types)',
  213.      *   'stored_fields'    => '(list) A comma-separated list of stored fields to return in the response',
  214.      *   'preference'       => '(string) Specify the node or shard the operation should be performed on (default: random)',
  215.      *   'realtime'         => '(boolean) Specify whether to perform the operation in realtime or search mode',
  216.      *   'refresh'          => '(boolean) Refresh the shard containing the document before performing the operation',
  217.      *   'routing'          => '(string) Specific routing value',
  218.      *   '_source'          => '(list) True or false to return the _source field or not, or a list of fields to return',
  219.      *   '_source_excludes' => '(list) A list of fields to exclude from the returned _source field',
  220.      *   '_source_includes' => '(list) A list of fields to extract and return from the _source field',
  221.      *   'version'          => '(number) Explicit version number for concurrency control',
  222.      *   'version_type'     => '(enum) Specific version type (Options = internal,external,external_gte,force)',
  223.      * ]
  224.      * @return callable|array
  225.      */
  226.     public function get(array $params)
  227.     {
  228.         $id = $this->extractArgument($params, 'id');
  229.         $index = $this->extractArgument($params, 'index');
  230.         $type = $this->extractArgument($params, 'type');
  232.         /**
  233.  * @var callable $endpointBuilder
  234. */
  235.         $endpointBuilder = $this->endpoints;
  237.         /**
  238.  * @var \Elasticsearch\Endpoints\Get $endpoint
  239. */
  240.         $endpoint = $endpointBuilder('Get');
  241.         $endpoint->setID($id)
  242.             ->setIndex($index)
  243.             ->setType($type);
  244.         $endpoint->setParams($params);
  246.         return $this->performRequest($endpoint);
  247.     }
  249.     /**
  250.      * Endpoint: get_source
  251.      *
  252.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html
  253.      *
  254.      * $params[
  255.      *   'id'               => '(string) The document ID (Required)',
  256.      *   'index'            => '(string) The name of the index (Required)',
  257.      *   'type'             => '(string) The type of the document; deprecated and optional starting with 7.0',
  258.      *   'preference'       => '(string) Specify the node or shard the operation should be performed on (default: random)',
  259.      *   'realtime'         => '(boolean) Specify whether to perform the operation in realtime or search mode',
  260.      *   'refresh'          => '(boolean) Refresh the shard containing the document before performing the operation',
  261.      *   'routing'          => '(string) Specific routing value',
  262.      *   '_source'          => '(list) True or false to return the _source field or not, or a list of fields to return',
  263.      *   '_source_excludes' => '(list) A list of fields to exclude from the returned _source field',
  264.      *   '_source_includes' => '(list) A list of fields to extract and return from the _source field',
  265.      *   'version'          => '(number) Explicit version number for concurrency control',
  266.      *   'version_type'     => '(enum) Specific version type (Options = internal,external,external_gte,force)',
  267.      * ]
  268.      * @return callable|array
  269.      */
  270.     public function getSource(array $params)
  271.     {
  272.         $id = $this->extractArgument($params, 'id');
  273.         $index = $this->extractArgument($params, 'index');
  274.         $type = $this->extractArgument($params, 'type');
  276.         /**
  277.  * @var callable $endpointBuilder
  278. */
  279.         $endpointBuilder = $this->endpoints;
  281.         /**
  282.  * @var \Elasticsearch\Endpoints\Get $endpoint
  283. */
  284.         $endpoint = $endpointBuilder('Source\Get');
  285.         $endpoint->setID($id)
  286.             ->setIndex($index)
  287.             ->setType($type);
  288.         $endpoint->setParams($params);
  290.         return $this->performRequest($endpoint);
  291.     }
  293.     /**
  294.      * Endpoint: exists_source
  295.      *
  296.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html
  297.      *
  298.      * $params[
  299.      *   'id'               => '(string) The document ID (Required)',
  300.      *   'index'            => '(string) The name of the index (Required)',
  301.      *   'type'             => '(string) The type of the document; deprecated and optional starting with 7.0',
  302.      *   'preference'       => '(string) Specify the node or shard the operation should be performed on (default: random)',
  303.      *   'realtime'         => '(boolean) Specify whether to perform the operation in realtime or search mode',
  304.      *   'refresh'          => '(boolean) Refresh the shard containing the document before performing the operation',
  305.      *   'routing'          => '(string) Specific routing value',
  306.      *   '_source'          => '(list) True or false to return the _source field or not, or a list of fields to return',
  307.      *   '_source_excludes' => '(list) A list of fields to exclude from the returned _source field',
  308.      *   '_source_includes' => '(list) A list of fields to extract and return from the _source field',
  309.      *   'version'          => '(number) Explicit version number for concurrency control',
  310.      *   'version_type'     => '(enum) Specific version type (Options = internal,external,external_gte,force)',
  311.      * ]
  312.      */
  313.     public function existsSource(array $params): bool
  314.     {
  315.         $id = $this->extractArgument($params, 'id');
  316.         $index = $this->extractArgument($params, 'index');
  317.         $type = $this->extractArgument($params, 'type');
  319.         // manually make this verbose so we can check status code
  320.         $params['client']['verbose'] = true;
  322.         /**
  323.  * @var callable $endpointBuilder
  324. */
  325.         $endpointBuilder = $this->endpoints;
  327.         /**
  328.  * @var \Elasticsearch\Endpoints\Exists $endpoint
  329. */
  330.         $endpoint = $endpointBuilder('Source\Exists');
  331.         $endpoint->setID($id)
  332.             ->setIndex($index)
  333.             ->setType($type);
  334.         $endpoint->setParams($params);
  336.         return BooleanRequestWrapper::performRequest($endpoint, $this->transport);
  337.     }
  339.     /**
  340.      * Endpoint: delete
  341.      *
  342.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html
  343.      *
  344.      * $params[
  345.      *   'id'                     => '(string) The document ID (Required)',
  346.      *   'index'                  => '(string) The name of the index (Required)',
  347.      *   'type'                   => '(string) The type of the document',
  348.      *   '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)',
  349.      *   'refresh'                => '(enum) If `true` then refresh the effected 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)',
  350.      *   'routing'                => '(string) Specific routing value',
  351.      *   'timeout'                => '(time) Explicit operation timeout',
  352.      *   'if_seq_no'              => '(number) only perform the delete operation if the last operation that has changed the document has the specified sequence number',
  353.      *   'if_primary_term'        => '(number) only perform the delete operation if the last operation that has changed the document has the specified primary term',
  354.      *   'version'                => '(number) Explicit version number for concurrency control',
  355.      *   'version_type'           => '(enum) Specific version type (Options = internal,external,external_gte,force)',
  356.      * ]
  357.      * @return callable|array
  358.      */
  359.     public function delete(array $params)
  360.     {
  361.         $id = $this->extractArgument($params, 'id');
  362.         $index = $this->extractArgument($params, 'index');
  363.         $type = $this->extractArgument($params, 'type');
  365.         $this->verifyNotNullOrEmpty("id", $id);
  366.         $this->verifyNotNullOrEmpty("index", $index);
  368.         /**
  369.  * @var callable $endpointBuilder
  370. */
  371.         $endpointBuilder = $this->endpoints;
  373.         /**
  374.  * @var \Elasticsearch\Endpoints\Delete $endpoint
  375. */
  376.         $endpoint = $endpointBuilder('Delete');
  377.         $endpoint->setID($id)
  378.             ->setIndex($index)
  379.             ->setType($type);
  380.         $endpoint->setParams($params);
  382.         return $this->performRequest($endpoint);
  383.     }
  385.     /**
  386.      * Endpoint: delete_by_query
  387.      *
  388.      * @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html
  389.      *
  390.      * $params[
  391.      *   'body'                   => '(string) The search definition using the Query DSL (Required)',
  392.      *   'index'                  => '(list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices (Required)',
  393.      *   'type'                   => '(list) A comma-separated list of document types to search; leave empty to perform the operation on all types',
  394.      *   'analyzer'               => '(string) The analyzer to use for the query string',
  395.      *   'analyze_wildcard'       => '(boolean) Specify whether wildcard and prefix queries should be analyzed (default: false)',
  396.      *   'default_operator'       => '(enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR)',
  397.      *   'df'                     => '(string) The field to use as default where no field prefix is given in the query string',
  398.      *   'from'                   => '(number) Starting offset (default: 0)',
  399.      *   'ignore_unavailable'     => '(boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)',
  400.      *   '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)',
  401.      *   'conflicts'              => '(enum) What to do when the delete by query hits version conflicts? (Options = abort,proceed) (Default = abort)',
  402.      *   'expand_wildcards'       => '(enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,none,all) (Default = open)',
  403.      *   'lenient'                => '(boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored',
  404.      *   'preference'             => '(string) Specify the node or shard the operation should be performed on (default: random)',
  405.      *   'q'                      => '(string) Query in the Lucene query string syntax',
  406.      *   'routing'                => '(list) A comma-separated list of specific routing values',
  407.      *   'scroll'                 => '(time) Specify how long a consistent view of the index should be maintained for scrolled search',
  408.      *   'search_type'            => '(enum) Search operation type (Options = query_then_fetch,dfs_query_then_fetch)',
  409.      *   'search_timeout'         => '(time) Explicit timeout for each search request. Defaults to no timeout.',
  410.      *   'size'                   => '(number) Number of hits to return (default: 10)',
  411.      *   'sort'                   => '(list) A comma-separated list of <field>:<direction> pairs',
  412.      *   '_source'                => '(list) True or false to return the _source field or not, or a list of fields to return',
  413.      *   '_source_excludes'       => '(list) A list of fields to exclude from the returned _source field',
  414.      *   '_source_includes'       => '(list) A list of fields to extract and return from the _source field',
  415.      *   'terminate_after'        => '(number) The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.',
  416.      *   'stats'                  => '(list) Specific 'tag' of the request for logging and statistical purposes',
  417.      *   'version'                => '(boolean) Specify whether to return document version as part of a hit',
  418.      *   'request_cache'          => '(boolean) Specify if request cache should be used for this request or not, defaults to index level setting',
  419.      *   'refresh'                => '(boolean) Should the effected indexes be refreshed?',
  420.      *   'timeout'                => '(time) Time each individual bulk request should wait for shards that are unavailable. (Default = 1m)',
  421.      *   '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)',
  422.      *   'scroll_size'            => '(number) Size on the scroll request powering the delete by query',
  423.      *   'wait_for_completion'    => '(boolean) Should the request should block until the delete by query is complete. (Default = true)',
  424.      *   'requests_per_second'    => '(number) The throttle for this request in sub-requests per second. -1 means no throttle. (Default = 0)',
  425.      *   'slices'                 => '(number) The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks. (Default = 1)',
  426.      * ]
  427.      * @return callable|array
  428.      */
  429.     public function deleteByQuery(array $params = [])
  430.     {
  431.         $index = $this->extractArgument($params, 'index');
  433.         $type = $this->extractArgument($params, 'type');
  435.         $body = $this->extractArgument($params, 'body');
  437.         /**
  438.  * @var callable $endpointBuilder
  439. */
  440.         $endpointBuilder = $this->endpoints;
  442.         /**
  443.  * @var \Elasticsearch\Endpoints\DeleteByQuery $endpoint
  444. */
  445.         $endpoint = $endpointBuilder('DeleteByQuery');
  446.         $endpoint->setIndex($index)
  447.             ->setType($type)
  448.             ->setBody($body);
  449.         $endpoint->setParams($params);
  451.         return $this->performRequest($endpoint);
  452.     }
  454.     /**
  455.      * Endpoint: delete_by_query_rethrottle
  456.      *
  457.      * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html
  458.      *
  459.      * $params[
  460.      *   'task_id'             => '(string) The task id to rethrottle (Required)',
  461.      *   'requests_per_second' => '(number) The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (Required)',
  462.      * ]
  463.      * @return callable|array
  464.      */
  465.     public function deleteByQueryRethrottle(array $params)
  466.     {
  467.         $taskId = $this->extractArgument($params, 'task_id');
  469.         /**
  470.  * @var callable $endpointBuilder
  471. */
  472.         $endpointBuilder = $this->endpoints;
  474.         /**
  475.  * @var \Elasticsearch\Endpoints\DeleteByQueryRethrottle $endpoint
  476. */
  477.         $endpoint = $endpointBuilder('DeleteByQueryRethrottle');
  478.         $endpoint->setTaskId($taskId);
  479.         $endpoint->setParams($params);
  481.         return $this->performRequest($endpoint);
  482.     }
  484.     /**
  485.      * Endpoint: count
  486.      *
  487.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html
  488.      *
  489.      * $params[
  490.      *   'body'               => '(string) A query to restrict the results specified with the Query DSL (optional)',
  491.      *   'index'              => '(list) A comma-separated list of indices to restrict the results',
  492.      *   'type'               => '(list) A comma-separated list of types to restrict the results',
  493.      *   'ignore_unavailable' => '(boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)',
  494.      *   'ignore_throttled'   => '(boolean) Whether specified concrete, expanded or aliased indices should be ignored when throttled',
  495.      *   '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)',
  496.      *   'expand_wildcards'   => '(enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,none,all) (Default = open)',
  497.      *   'min_score'          => '(number) Include only documents with a specific `_score` value in the result',
  498.      *   'preference'         => '(string) Specify the node or shard the operation should be performed on (default: random)',
  499.      *   'routing'            => '(list) A comma-separated list of specific routing values',
  500.      *   'q'                  => '(string) Query in the Lucene query string syntax',
  501.      *   'analyzer'           => '(string) The analyzer to use for the query string',
  502.      *   'analyze_wildcard'   => '(boolean) Specify whether wildcard and prefix queries should be analyzed (default: false)',
  503.      *   'default_operator'   => '(enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR)',
  504.      *   'df'                 => '(string) The field to use as default where no field prefix is given in the query string',
  505.      *   'lenient'            => '(boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored',
  506.      *   'terminate_after'    => '(number) The maximum count for each shard, upon reaching which the query execution will terminate early',
  507.      * ]
  508.      * @return callable|array
  509.      */
  510.     public function count(array $params = [])
  511.     {
  512.         $index = $this->extractArgument($params, 'index');
  513.         $type = $this->extractArgument($params, 'type');
  514.         $body = $this->extractArgument($params, 'body');
  516.         /**
  517.  * @var callable $endpointBuilder
  518. */
  519.         $endpointBuilder = $this->endpoints;
  521.         /**
  522.  * @var \Elasticsearch\Endpoints\Count $endpoint
  523. */
  524.         $endpoint = $endpointBuilder('Count');
  525.         $endpoint->setIndex($index)
  526.             ->setType($type)
  527.             ->setBody($body);
  528.         $endpoint->setParams($params);
  530.         return $this->performRequest($endpoint);
  531.     }
  533.     /**
  534.      * Endpoint: termvectors
  535.      *
  536.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html
  537.      *
  538.      * $params[
  539.      *   'body'             => '(string) Define parameters and or supply a document to get termvectors for. See documentation.',
  540.      *   'index'            => '(string) The index in which the document resides. (Required)',
  541.      *   'type'             => '(string) The type of the document.',
  542.      *   'id'               => '(string) The id of the document, when not specified a doc param should be supplied.',
  543.      *   'term_statistics'  => '(boolean) Specifies if total term frequency and document frequency should be returned. (Default = false)',
  544.      *   'field_statistics' => '(boolean) Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. (Default = true)',
  545.      *   'fields'           => '(list) A comma-separated list of fields to return.',
  546.      *   'offsets'          => '(boolean) Specifies if term offsets should be returned. (Default = true)',
  547.      *   'positions'        => '(boolean) Specifies if term positions should be returned. (Default = true)',
  548.      *   'payloads'         => '(boolean) Specifies if term payloads should be returned. (Default = true)',
  549.      *   'preference'       => '(string) Specify the node or shard the operation should be performed on (default: random).',
  550.      *   'routing'          => '(string) Specific routing value.',
  551.      *   'realtime'         => '(boolean) Specifies if request is real-time as opposed to near-real-time (default: true).',
  552.      *   'version'          => '(number) Explicit version number for concurrency control',
  553.      *   'version_type'     => '(enum) Specific version type (Options = internal,external,external_gte,force)',
  554.      * ]
  555.      * @return callable|array
  556.      */
  557.     public function termvectors(array $params = [])
  558.     {
  559.         $index = $this->extractArgument($params, 'index');
  560.         $type  = $this->extractArgument($params, 'type');
  561.         $id    = $this->extractArgument($params, 'id');
  562.         $body  = $this->extractArgument($params, 'body');
  564.         /**
  565.  * @var callable $endpointBuilder
  566. */
  567.         $endpointBuilder = $this->endpoints;
  569.         /**
  570.  * @var \Elasticsearch\Endpoints\TermVectors $endpoint
  571. */
  572.         $endpoint = $endpointBuilder('TermVectors');
  573.         $endpoint->setIndex($index)
  574.             ->setType($type)
  575.             ->setID($id)
  576.             ->setBody($body);
  577.         $endpoint->setParams($params);
  579.         return $this->performRequest($endpoint);
  580.     }
  582.     /**
  583.      * Endpoint: mtermvectors
  584.      *
  585.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html
  586.      *
  587.      * $params[
  588.      *   'body'             => '(string) Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.',
  589.      *   'index'            => '(string) The index in which the document resides.',
  590.      *   'type'             => '(string) The type of the document.',
  591.      *   'ids'              => '(list) A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body',
  592.      *   '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)',
  593.      *   '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)',
  594.      *   'fields'           => '(list) A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body "params" or "docs".',
  595.      *   'offsets'          => '(boolean) Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". (Default = true)',
  596.      *   'positions'        => '(boolean) Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". (Default = true)',
  597.      *   'payloads'         => '(boolean) Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". (Default = true)',
  598.      *   '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".',
  599.      *   'routing'          => '(string) Specific routing value. Applies to all returned documents unless otherwise specified in body "params" or "docs".',
  600.      *   'realtime'         => '(boolean) Specifies if requests are real-time as opposed to near-real-time (default: true).',
  601.      *   'version'          => '(number) Explicit version number for concurrency control',
  602.      *   'version_type'     => '(enum) Specific version type (Options = internal,external,external_gte,force)',
  603.      * ]
  604.      * @return callable|array
  605.      */
  606.     public function mtermvectors(array $params = [])
  607.     {
  608.         $index = $this->extractArgument($params, 'index');
  609.         $type  = $this->extractArgument($params, 'type');
  610.         $body  = $this->extractArgument($params, 'body');
  612.         /**
  613.  * @var callable $endpointBuilder
  614. */
  615.         $endpointBuilder = $this->endpoints;
  617.         /**
  618.  * @var \Elasticsearch\Endpoints\MTermVectors $endpoint
  619. */
  620.         $endpoint = $endpointBuilder('MTermVectors');
  621.         $endpoint->setIndex($index)
  622.             ->setType($type)
  623.             ->setBody($body);
  624.         $endpoint->setParams($params);
  626.         return $this->performRequest($endpoint);
  627.     }
  629.     /**
  630.      * Endpoint: exists
  631.      *
  632.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html
  633.      *
  634.      * $params[
  635.      *   'id'               => '(string) The document ID (Required)',
  636.      *   'index'            => '(string) The name of the index (Required)',
  637.      *   'type'             => '(string) The type of the document (use `_all` to fetch the first document matching the ID across all types)',
  638.      *   'stored_fields'    => '(list) A comma-separated list of stored fields to return in the response',
  639.      *   'preference'       => '(string) Specify the node or shard the operation should be performed on (default: random)',
  640.      *   'realtime'         => '(boolean) Specify whether to perform the operation in realtime or search mode',
  641.      *   'refresh'          => '(boolean) Refresh the shard containing the document before performing the operation',
  642.      *   'routing'          => '(string) Specific routing value',
  643.      *   '_source'          => '(list) True or false to return the _source field or not, or a list of fields to return',
  644.      *   '_source_excludes' => '(list) A list of fields to exclude from the returned _source field',
  645.      *   '_source_includes' => '(list) A list of fields to extract and return from the _source field',
  646.      *   'version'          => '(number) Explicit version number for concurrency control',
  647.      *   'version_type'     => '(enum) Specific version type (Options = internal,external,external_gte,force)',
  648.      * ]
  649.      */
  650.     public function exists(array $params): bool
  651.     {
  652.         $id = $this->extractArgument($params, 'id');
  653.         $index = $this->extractArgument($params, 'index');
  654.         $type = $this->extractArgument($params, 'type');
  656.         // manually make this verbose so we can check status code
  657.         $params['client']['verbose'] = true;
  659.         /**
  660.  * @var callable $endpointBuilder
  661. */
  662.         $endpointBuilder = $this->endpoints;
  664.         /**
  665.  * @var \Elasticsearch\Endpoints\Exists $endpoint
  666. */
  667.         $endpoint = $endpointBuilder('Exists');
  668.         $endpoint->setID($id)
  669.             ->setIndex($index)
  670.             ->setType($type);
  672.         $endpoint->setParams($params);
  674.         return BooleanRequestWrapper::performRequest($endpoint, $this->transport);
  675.     }
  677.     /**
  678.      * Endpoint: mget
  679.      *
  680.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html
  681.      *
  682.      * $params[
  683.      *   'body'             => '(string) Document identifiers; can be either `docs` (containing full document information) or `ids` (when index and type is provided in the URL. (Required)',
  684.      *   'index'            => '(string) The name of the index',
  685.      *   'type'             => '(string) The type of the document',
  686.      *   'stored_fields'    => '(list) A comma-separated list of stored fields to return in the response',
  687.      *   'preference'       => '(string) Specify the node or shard the operation should be performed on (default: random)',
  688.      *   'realtime'         => '(boolean) Specify whether to perform the operation in realtime or search mode',
  689.      *   'refresh'          => '(boolean) Refresh the shard containing the document before performing the operation',
  690.      *   'routing'          => '(string) Specific routing value',
  691.      *   '_source'          => '(list) True or false to return the _source field or not, or a list of fields to return',
  692.      *   '_source_excludes' => '(list) A list of fields to exclude from the returned _source field',
  693.      *   '_source_includes' => '(list) A list of fields to extract and return from the _source field',
  694.      * ]
  695.      * @return callable|array
  696.      */
  697.     public function mget(array $params = [])
  698.     {
  699.         $index = $this->extractArgument($params, 'index');
  700.         $type = $this->extractArgument($params, 'type');
  701.         $body = $this->extractArgument($params, 'body');
  703.         /**
  704.  * @var callable $endpointBuilder
  705. */
  706.         $endpointBuilder = $this->endpoints;
  708.         /**
  709.  * @var \Elasticsearch\Endpoints\Mget $endpoint
  710. */
  711.         $endpoint = $endpointBuilder('Mget');
  712.         $endpoint->setIndex($index)
  713.             ->setType($type)
  714.             ->setBody($body);
  715.         $endpoint->setParams($params);
  717.         return $this->performRequest($endpoint);
  718.     }
  720.     /**
  721.      * Endpoint: msearch
  722.      *
  723.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html
  724.      *
  725.      * $params[
  726.      *   'body'                          => '(string) The request definitions (metadata-search request definition pairs), separated by newlines (Required)',
  727.      *   'index'                         => '(list) A comma-separated list of index names to use as default',
  728.      *   'type'                          => '(list) A comma-separated list of document types to use as default',
  729.      *   'search_type'                   => '(enum) Search operation type (Options = query_then_fetch,query_and_fetch,dfs_query_then_fetch,dfs_query_and_fetch)',
  730.      *   'max_concurrent_searches'       => '(number) Controls the maximum number of concurrent searches the multi search api will execute',
  731.      *   'typed_keys'                    => '(boolean) Specify whether aggregation and suggester names should be prefixed by their respective types in the response',
  732.      *   '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 it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. (Default = 128)',
  733.      *   '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)',
  734.      *   '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)',
  735.      *   'ccs_minimize_roundtrips'       => '(boolean) Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution (Default = true)',
  736.      * ]
  737.      * @return callable|array
  738.      */
  739.     public function msearch(array $params = [])
  740.     {
  741.         $index = $this->extractArgument($params, 'index');
  742.         $type = $this->extractArgument($params, 'type');
  743.         $body = $this->extractArgument($params, 'body');
  745.         /**
  746.  * @var callable $endpointBuilder
  747. */
  748.         $endpointBuilder = $this->endpoints;
  750.         /**
  751.  * @var \Elasticsearch\Endpoints\Msearch $endpoint
  752. */
  753.         $endpoint = $endpointBuilder('Msearch');
  754.         $endpoint->setIndex($index)
  755.             ->setType($type)
  756.             ->setBody($body);
  757.         $endpoint->setParams($params);
  759.         return $this->performRequest($endpoint);
  760.     }
  762.     /**
  763.      * Endpoint: msearch_template
  764.      *
  765.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html
  766.      *
  767.      * $params[
  768.      *   'body'                    => '(string) The request definitions (metadata-search request definition pairs), separated by newlines (Required)',
  769.      *   'index'                   => '(list) A comma-separated list of index names to use as default',
  770.      *   'type'                    => '(list) A comma-separated list of document types to use as default',
  771.      *   'search_type'             => '(enum) Search operation type (Options = query_then_fetch,query_and_fetch,dfs_query_then_fetch,dfs_query_and_fetch)',
  772.      *   'typed_keys'              => '(boolean) Specify whether aggregation and suggester names should be prefixed by their respective types in the response',
  773.      *   'max_concurrent_searches' => '(number) Controls the maximum number of concurrent searches the multi search api will execute',
  774.      *   '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)',
  775.      *   'ccs_minimize_roundtrips' => '(boolean) Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution (Default = true)',
  776.      * ]
  777.      * @return callable|array
  778.      */
  779.     public function msearchTemplate(array $params = [])
  780.     {
  781.         $index = $this->extractArgument($params, 'index');
  782.         $type = $this->extractArgument($params, 'type');
  783.         $body = $this->extractArgument($params, 'body');
  785.         /**
  786.  * @var callable $endpointBuilder
  787. */
  788.         $endpointBuilder = $this->endpoints;
  790.         /**
  791.  * @var \Elasticsearch\Endpoints\MsearchTemplate $endpoint
  792. */
  793.         $endpoint = $endpointBuilder('MsearchTemplate');
  794.         $endpoint->setIndex($index)
  795.             ->setType($type)
  796.             ->setBody($body);
  797.         $endpoint->setParams($params);
  799.         return $this->performRequest($endpoint);
  800.     }
  802.     /**
  803.      * Endpoint: create
  804.      *
  805.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html
  806.      *
  807.      * $params[
  808.      *   'body'                   => '(string) The document (Required)',
  809.      *   'id'                     => '(string) Document ID (Required)',
  810.      *   'index'                  => '(string) The name of the index (Required)',
  811.      *   'type'                   => '(string) The type of the document',
  812.      *   '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)',
  813.      *   '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)',
  814.      *   'routing'                => '(string) Specific routing value',
  815.      *   'timeout'                => '(time) Explicit operation timeout',
  816.      *   'version'                => '(number) Explicit version number for concurrency control',
  817.      *   'version_type'           => '(enum) Specific version type (Options = internal,external,external_gte,force)',
  818.      *   'pipeline'               => '(string) The pipeline id to preprocess incoming documents with',
  819.      * ]
  820.      * @return callable|array
  821.      */
  822.     public function create(array $params)
  823.     {
  824.         $id = $this->extractArgument($params, 'id');
  825.         $index = $this->extractArgument($params, 'index');
  826.         $type = $this->extractArgument($params, 'type');
  827.         $body = $this->extractArgument($params, 'body');
  829.         /**
  830.  * @var callable $endpointBuilder
  831. */
  832.         $endpointBuilder = $this->endpoints;
  834.         /**
  835.  * @var \Elasticsearch\Endpoints\Create $endpoint
  836. */
  837.         $endpoint = $endpointBuilder('Create');
  838.         $endpoint->setID($id)
  839.             ->setIndex($index)
  840.             ->setType($type)
  841.             ->setBody($body);
  842.         $endpoint->setParams($params);
  844.         return $this->performRequest($endpoint);
  845.     }
  847.     /**
  848.      * Endpoint: bulk
  849.      *
  850.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html
  851.      *
  852.      * $params[
  853.      *   'body'                   => '(string) The operation definition and data (action-data pairs), separated by newlines (Required)',
  854.      *   'index'                  => '(string) Default index for items which don't provide one',
  855.      *   'type'                   => '(string) Default document type for items which don't provide one',
  856.      *   '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)',
  857.      *   'refresh'                => '(enum) If `true` then refresh the effected 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)',
  858.      *   'routing'                => '(string) Specific routing value',
  859.      *   'timeout'                => '(time) Explicit operation timeout',
  860.      *   'type'                   => '(string) Default document type for items which don't provide one',
  861.      *   '_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',
  862.      *   '_source_excludes'       => '(list) Default list of fields to exclude from the returned _source field, can be overridden on each sub-request',
  863.      *   '_source_includes'       => '(list) Default list of fields to extract and return from the _source field, can be overridden on each sub-request',
  864.      *   'pipeline'               => '(string) The pipeline id to preprocess incoming documents with',
  865.      * ]
  866.      * @return callable|array
  867.      */
  868.     public function bulk(array $params = [])
  869.     {
  870.         $index = $this->extractArgument($params, 'index');
  871.         $type = $this->extractArgument($params, 'type');
  872.         $body = $this->extractArgument($params, 'body');
  874.         /**
  875.  * @var callable $endpointBuilder
  876. */
  877.         $endpointBuilder = $this->endpoints;
  879.         /**
  880.  * @var \Elasticsearch\Endpoints\Bulk $endpoint
  881. */
  882.         $endpoint = $endpointBuilder('Bulk');
  883.         $endpoint->setIndex($index)
  884.             ->setType($type)
  885.             ->setBody($body);
  886.         $endpoint->setParams($params);
  888.         return $this->performRequest($endpoint);
  889.     }
  891.     /**
  892.      * Endpoint: index
  893.      *
  894.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html
  895.      *
  896.      * $params[
  897.      *   'body'                   => '(string) The document (Required)',
  898.      *   'id'                     => '(string) Document ID',
  899.      *   'index'                  => '(string) The name of the index (Required)',
  900.      *   'type'                   => '(string) The type of the document',
  901.      *   '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)',
  902.      *   'op_type'                => '(enum) Explicit operation type (Options = index,create) (Default = index)',
  903.      *   '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)',
  904.      *   'routing'                => '(string) Specific routing value',
  905.      *   'timeout'                => '(time) Explicit operation timeout',
  906.      *   'version'                => '(number) Explicit version number for concurrency control',
  907.      *   'version_type'           => '(enum) Specific version type (Options = internal,external,external_gte,force)',
  908.      *   'if_seq_no'              => '(number) only perform the index operation if the last operation that has changed the document has the specified sequence number',
  909.      *   'if_primary_term'        => '(number) only perform the index operation if the last operation that has changed the document has the specified primary term',
  910.      *   'pipeline'               => '(string) The pipeline id to preprocess incoming documents with',
  911.      * ]
  912.      * @return callable|array
  913.      */
  914.     public function index(array $params)
  915.     {
  916.         $id = $this->extractArgument($params, 'id');
  917.         $index = $this->extractArgument($params, 'index');
  918.         $type = $this->extractArgument($params, 'type');
  919.         $body = $this->extractArgument($params, 'body');
  921.         /**
  922.  * @var callable $endpointBuilder
  923. */
  924.         $endpointBuilder = $this->endpoints;
  926.         /**
  927.  * @var \Elasticsearch\Endpoints\Index $endpoint
  928. */
  929.         $endpoint = $endpointBuilder('Index');
  930.         $endpoint->setID($id)
  931.             ->setIndex($index)
  932.             ->setType($type)
  933.             ->setBody($body);
  934.         $endpoint->setParams($params);
  936.         return $this->performRequest($endpoint);
  937.     }
  939.     /**
  940.      * Endpoint: reindex
  941.      *
  942.      * @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html
  943.      *
  944.      * $params[
  945.      *   'body'                   => '(string) The search definition using the Query DSL and the prototype for the index request. (Required)',
  946.      *   'refresh'                => '(boolean) Should the effected indexes be refreshed?',
  947.      *   'timeout'                => '(time) Time each individual bulk request should wait for shards that are unavailable. (Default = 1m)',
  948.      *   '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)',
  949.      *   'wait_for_completion'    => '(boolean) Should the request should block until the reindex is complete. (Default = true)',
  950.      *   'requests_per_second'    => '(number) The throttle to set on this request in sub-requests per second. -1 means no throttle. (Default = 0)',
  951.      *   'scroll'                 => '(time) Control how long to keep the search context alive (Default = 5m)',
  952.      *   'slices'                 => '(number) The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks. (Default = 1)',
  953.      * ]
  954.      * @return callable|array
  955.      */
  956.     public function reindex(array $params)
  957.     {
  958.         $body = $this->extractArgument($params, 'body');
  960.         /**
  961.  * @var callable $endpointBuilder
  962. */
  963.         $endpointBuilder = $this->endpoints;
  964.         /**
  965.  * @var \Elasticsearch\Endpoints\Reindex $endpoint
  966. */
  967.         $endpoint = $endpointBuilder('Reindex');
  968.         $endpoint->setBody($body);
  969.         $endpoint->setParams($params);
  971.         return $this->performRequest($endpoint);
  972.     }
  974.     /**
  975.      * Endpoint: reindex_rethrottle
  976.      *
  977.      * @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html
  978.      *
  979.      * $params[
  980.      *   'task_id'             => '(string) The task id to rethrottle (Required)',
  981.      *   'requests_per_second' => '(number) The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (Required)',
  982.      * ]
  983.      * @return callable|array
  984.      */
  985.     public function reindexRethrottle(array $params)
  986.     {
  987.         $taskId = $this->extractArgument($params, 'task_id');
  989.         /**
  990.  * @var callable $endpointBuilder
  991. */
  992.         $endpointBuilder = $this->endpoints;
  993.         /**
  994.  * @var \Elasticsearch\Endpoints\ReindexRethrottle $endpoint
  995. */
  996.         $endpoint = $endpointBuilder('ReindexRethrottle');
  997.         $endpoint->setTaskId($taskId);
  998.         $endpoint->setParams($params);
  1000.         return $this->performRequest($endpoint);
  1001.     }
  1003.     /**
  1004.      * Endpoint: explain
  1005.      *
  1006.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html
  1007.      *
  1008.      * $params[
  1009.      *   'body'             => '(string) The query definition using the Query DSL',
  1010.      *   'id'               => '(string) The document ID (Required)',
  1011.      *   'index'            => '(string) The name of the index (Required)',
  1012.      *   'type'             => '(string) The type of the document',
  1013.      *   'analyze_wildcard' => '(boolean) Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)',
  1014.      *   'analyzer'         => '(string) The analyzer for the query string query',
  1015.      *   'default_operator' => '(enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR)',
  1016.      *   'df'               => '(string) The default field for query string query (default: _all)',
  1017.      *   'stored_fields'    => '(list) A comma-separated list of stored fields to return in the response',
  1018.      *   'lenient'          => '(boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored',
  1019.      *   'preference'       => '(string) Specify the node or shard the operation should be performed on (default: random)',
  1020.      *   'q'                => '(string) Query in the Lucene query string syntax',
  1021.      *   'routing'          => '(string) Specific routing value',
  1022.      *   '_source'          => '(list) True or false to return the _source field or not, or a list of fields to return',
  1023.      *   '_source_excludes' => '(list) A list of fields to exclude from the returned _source field',
  1024.      *   '_source_includes' => '(list) A list of fields to extract and return from the _source field',
  1025.      * ]
  1026.      * @return callable|array
  1027.      */
  1028.     public function explain(array $params)
  1029.     {
  1030.         $id = $this->extractArgument($params, 'id');
  1031.         $index = $this->extractArgument($params, 'index');
  1032.         $type = $this->extractArgument($params, 'type');
  1033.         $body = $this->extractArgument($params, 'body');
  1035.         /**
  1036.  * @var callable $endpointBuilder
  1037. */
  1038.         $endpointBuilder = $this->endpoints;
  1040.         /**
  1041.  * @var \Elasticsearch\Endpoints\Explain $endpoint
  1042. */
  1043.         $endpoint = $endpointBuilder('Explain');
  1044.         $endpoint->setID($id)
  1045.             ->setIndex($index)
  1046.             ->setType($type)
  1047.             ->setBody($body);
  1048.         $endpoint->setParams($params);
  1050.         return $this->performRequest($endpoint);
  1051.     }
  1053.     /**
  1054.      * Endpoint: search
  1055.      *
  1056.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html
  1057.      *
  1058.      * $params[
  1059.      *   'body'                          => '(string) The search definition using the Query DSL',
  1060.      *   'index'                         => '(list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices',
  1061.      *   'type'                          => '(list) A comma-separated list of document types to search; leave empty to perform the operation on all types',
  1062.      *   'analyzer'                      => '(string) The analyzer to use for the query string',
  1063.      *   'analyze_wildcard'              => '(boolean) Specify whether wildcard and prefix queries should be analyzed (default: false)',
  1064.      *   'ccs_minimize_roundtrips'       => '(boolean) Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution (Default = true)',
  1065.      *   'default_operator'              => '(enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR)',
  1066.      *   'df'                            => '(string) The field to use as default where no field prefix is given in the query string',
  1067.      *   'explain'                       => '(boolean) Specify whether to return detailed information about score computation as part of a hit',
  1068.      *   'stored_fields'                 => '(list) A comma-separated list of stored fields to return as part of a hit',
  1069.      *   'docvalue_fields'               => '(list) A comma-separated list of fields to return as the docvalue representation of a field for each hit',
  1070.      *   'from'                          => '(number) Starting offset (default: 0)',
  1071.      *   'ignore_unavailable'            => '(boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)',
  1072.      *   'ignore_throttled'              => '(boolean) Whether specified concrete, expanded or aliased indices should be ignored when throttled',
  1073.      *   '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)',
  1074.      *   'expand_wildcards'              => '(enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,none,all) (Default = open)',
  1075.      *   'lenient'                       => '(boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored',
  1076.      *   'preference'                    => '(string) Specify the node or shard the operation should be performed on (default: random)',
  1077.      *   'q'                             => '(string) Query in the Lucene query string syntax',
  1078.      *   'routing'                       => '(list) A comma-separated list of specific routing values',
  1079.      *   'scroll'                        => '(time) Specify how long a consistent view of the index should be maintained for scrolled search',
  1080.      *   'search_type'                   => '(enum) Search operation type (Options = query_then_fetch,dfs_query_then_fetch)',
  1081.      *   'size'                          => '(number) Number of hits to return (default: 10)',
  1082.      *   'sort'                          => '(list) A comma-separated list of <field>:<direction> pairs',
  1083.      *   '_source'                       => '(list) True or false to return the _source field or not, or a list of fields to return',
  1084.      *   '_source_excludes'              => '(list) A list of fields to exclude from the returned _source field',
  1085.      *   '_source_includes'              => '(list) A list of fields to extract and return from the _source field',
  1086.      *   'terminate_after'               => '(number) The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.',
  1087.      *   'stats'                         => '(list) Specific 'tag' of the request for logging and statistical purposes',
  1088.      *   'suggest_field'                 => '(string) Specify which field to use for suggestions',
  1089.      *   'suggest_mode'                  => '(enum) Specify suggest mode (Options = missing,popular,always) (Default = missing)',
  1090.      *   'suggest_size'                  => '(number) How many suggestions to return in response',
  1091.      *   'suggest_text'                  => '(string) The source text for which the suggestions should be returned',
  1092.      *   'timeout'                       => '(time) Explicit operation timeout',
  1093.      *   'track_scores'                  => '(boolean) Whether to calculate and return scores even if they are not used for sorting',
  1094.      *   'track_total_hits'              => '(boolean) Indicate if the number of documents that match the query should be tracked',
  1095.      *   'allow_partial_search_results'  => '(boolean) Indicate if an error should be returned if there is a partial search failure or timeout (Default = true)',
  1096.      *   'typed_keys'                    => '(boolean) Specify whether aggregation and suggester names should be prefixed by their respective types in the response',
  1097.      *   'version'                       => '(boolean) Specify whether to return document version as part of a hit',
  1098.      *   'seq_no_primary_term'           => '(boolean) Specify whether to return sequence number and primary term of the last modification of each hit',
  1099.      *   'request_cache'                 => '(boolean) Specify if request cache should be used for this request or not, defaults to index level setting',
  1100.      *   '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)',
  1101.      *   '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)',
  1102.      *   '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 it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. (Default = 128)',
  1103.      *   '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)',
  1104.      * ]
  1105.      * @return callable|array
  1106.      */
  1107.     public function search(array $params = [])
  1108.     {
  1109.         $index = $this->extractArgument($params, 'index');
  1110.         $type = $this->extractArgument($params, 'type');
  1111.         $body = $this->extractArgument($params, 'body');
  1113.         /**
  1114.  * @var callable $endpointBuilder
  1115. */
  1116.         $endpointBuilder = $this->endpoints;
  1118.         /**
  1119.  * @var \Elasticsearch\Endpoints\Search $endpoint
  1120. */
  1121.         $endpoint = $endpointBuilder('Search');
  1122.         $endpoint->setIndex($index)
  1123.             ->setType($type)
  1124.             ->setBody($body);
  1125.         $endpoint->setParams($params);
  1127.         return $this->performRequest($endpoint);
  1128.     }
  1130.     /**
  1131.      * Endpoint: search_shards
  1132.      *
  1133.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html
  1134.      *
  1135.      * $params[
  1136.      *   'index'              => '(list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices',
  1137.      *   'preference'         => '(string) Specify the node or shard the operation should be performed on (default: random)',
  1138.      *   'routing'            => '(string) Specific routing value',
  1139.      *   'local'              => '(boolean) Return local information, do not retrieve the state from master node (default: false)',
  1140.      *   'ignore_unavailable' => '(boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)',
  1141.      *   '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)',
  1142.      *   'expand_wildcards'   => '(enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,none,all) (Default = open)',
  1143.      * ]
  1144.      * @return callable|array
  1145.      */
  1146.     public function searchShards(array $params = [])
  1147.     {
  1148.         $index = $this->extractArgument($params, 'index');
  1149.         $type = $this->extractArgument($params, 'type');
  1151.         /**
  1152.  * @var callable $endpointBuilder
  1153. */
  1154.         $endpointBuilder = $this->endpoints;
  1156.         /**
  1157.  * @var \Elasticsearch\Endpoints\SearchShards $endpoint
  1158. */
  1159.         $endpoint = $endpointBuilder('SearchShards');
  1160.         $endpoint->setIndex($index)
  1161.             ->setType($type);
  1162.         $endpoint->setParams($params);
  1164.         return $this->performRequest($endpoint);
  1165.     }
  1167.     /**
  1168.      * Endpoint: search_template
  1169.      *
  1170.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html
  1171.      *
  1172.      * $params[
  1173.      *   'body'                    => '(string) The search definition template and its params (Required)',
  1174.      *   'index'                   => '(list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices',
  1175.      *   'type'                    => '(list) A comma-separated list of document types to search; leave empty to perform the operation on all types',
  1176.      *   'ignore_unavailable'      => '(boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)',
  1177.      *   'ignore_throttled'        => '(boolean) Whether specified concrete, expanded or aliased indices should be ignored when throttled',
  1178.      *   '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)',
  1179.      *   'expand_wildcards'        => '(enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,none,all) (Default = open)',
  1180.      *   'preference'              => '(string) Specify the node or shard the operation should be performed on (default: random)',
  1181.      *   'routing'                 => '(list) A comma-separated list of specific routing values',
  1182.      *   'scroll'                  => '(time) Specify how long a consistent view of the index should be maintained for scrolled search',
  1183.      *   'search_type'             => '(enum) Search operation type (Options = query_then_fetch,query_and_fetch,dfs_query_then_fetch,dfs_query_and_fetch)',
  1184.      *   'explain'                 => '(boolean) Specify whether to return detailed information about score computation as part of a hit',
  1185.      *   'profile'                 => '(boolean) Specify whether to profile the query execution',
  1186.      *   'typed_keys'              => '(boolean) Specify whether aggregation and suggester names should be prefixed by their respective types in the response',
  1187.      *   '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)',
  1188.      *   'ccs_minimize_roundtrips' => '(boolean) Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution (Default = true)',
  1189.      * ]
  1190.      * @return callable|array
  1191.      */
  1192.     public function searchTemplate(array $params = [])
  1193.     {
  1194.         $index = $this->extractArgument($params, 'index');
  1195.         $type = $this->extractArgument($params, 'type');
  1196.         $body = $this->extractArgument($params, 'body');
  1198.         /**
  1199.  * @var callable $endpointBuilder
  1200. */
  1201.         $endpointBuilder = $this->endpoints;
  1203.         /**
  1204.  * @var \Elasticsearch\Endpoints\Search $endpoint
  1205. */
  1206.         $endpoint = $endpointBuilder('SearchTemplate');
  1207.         $endpoint->setIndex($index)
  1208.             ->setType($type)
  1209.             ->setBody($body);
  1210.         $endpoint->setParams($params);
  1212.         return $this->performRequest($endpoint);
  1213.     }
  1215.     /**
  1216.      * Endpoint: scroll
  1217.      *
  1218.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html
  1219.      *
  1220.      * $params[
  1221.      *   'body'                   => '(string) The scroll ID if not passed by URL or query parameter.',
  1222.      *   'scroll_id'              => '(string) The scroll ID',
  1223.      *   'scroll'                 => '(time) Specify how long a consistent view of the index should be maintained for scrolled search',
  1224.      *   'scroll_id'              => '(string) The scroll ID for scrolled search',
  1225.      *   '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)',
  1226.      * ]
  1227.      * @return callable|array
  1228.      */
  1229.     public function scroll(array $params = [])
  1230.     {
  1231.         $scrollID = $this->extractArgument($params, 'scroll_id');
  1232.         $body = $this->extractArgument($params, 'body');
  1234.         /**
  1235.  * @var callable $endpointBuilder
  1236. */
  1237.         $endpointBuilder = $this->endpoints;
  1239.         /**
  1240.  * @var \Elasticsearch\Endpoints\Scroll $endpoint
  1241. */
  1242.         $endpoint = $endpointBuilder('Scroll');
  1243.         $endpoint->setScrollId($scrollID)
  1244.             ->setBody($body)
  1245.             ->setParams($params);
  1247.         return $this->performRequest($endpoint);
  1248.     }
  1250.     /**
  1251.      * $params['body'] = (string) The script to execute
  1252.      *
  1253.      * @return callable|array
  1254.      */
  1255.     public function scriptsPainlessExecute(array $params = [])
  1256.     {
  1257.         $body = $this->extractArgument($params, 'body');
  1259.         /**
  1260.  * @var callable $endpointBuilder
  1261. */
  1262.         $endpointBuilder = $this->endpoints;
  1264.         /**
  1265.  * @var \Elasticsearch\Endpoints\ScriptsPainlessExecute $endpoint
  1266. */
  1267.         $endpoint = $endpointBuilder('ScriptsPainlessExecute');
  1268.         $endpoint->setBody($body);
  1269.         $endpoint->setParams($params);
  1271.         return $this->performRequest($endpoint);
  1272.     }
  1274.     /**
  1275.      * Endpoint: clear_scroll
  1276.      *
  1277.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html
  1278.      *
  1279.      * $params[
  1280.      *   'body'      => '(string) A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter',
  1281.      *   'scroll_id' => '(list) A comma-separated list of scroll IDs to clear',
  1282.      * ]
  1283.      * @return callable|array
  1284.      */
  1285.     public function clearScroll(array $params = [])
  1286.     {
  1287.         $scrollID = $this->extractArgument($params, 'scroll_id');
  1288.         $body = $this->extractArgument($params, 'body');
  1290.         /**
  1291.  * @var callable $endpointBuilder
  1292. */
  1293.         $endpointBuilder = $this->endpoints;
  1295.         /**
  1296.  * @var \Elasticsearch\Endpoints\ClearScroll $endpoint
  1297. */
  1298.         $endpoint = $endpointBuilder('ClearScroll');
  1299.         $endpoint->setScrollId($scrollID)
  1300.             ->setBody($body);
  1301.         $endpoint->setParams($params);
  1303.         return $this->performRequest($endpoint);
  1304.     }
  1306.     /**
  1307.      * Endpoint: update
  1308.      *
  1309.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html
  1310.      *
  1311.      * $params[
  1312.      *   'body'                   => '(string) The request definition requires either `script` or partial `doc` (Required)',
  1313.      *   'id'                     => '(string) Document ID (Required)',
  1314.      *   'index'                  => '(string) The name of the index (Required)',
  1315.      *   'type'                   => '(string) The type of the document',
  1316.      *   '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)',
  1317.      *   '_source'                => '(list) True or false to return the _source field or not, or a list of fields to return',
  1318.      *   '_source_excludes'       => '(list) A list of fields to exclude from the returned _source field',
  1319.      *   '_source_includes'       => '(list) A list of fields to extract and return from the _source field',
  1320.      *   'lang'                   => '(string) The script language (default: painless)',
  1321.      *   'refresh'                => '(enum) If `true` then refresh the effected 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)',
  1322.      *   'retry_on_conflict'      => '(number) Specify how many times should the operation be retried when a conflict occurs (default: 0)',
  1323.      *   'routing'                => '(string) Specific routing value',
  1324.      *   'timeout'                => '(time) Explicit operation timeout',
  1325.      *   'if_seq_no'              => '(number) only perform the update operation if the last operation that has changed the document has the specified sequence number',
  1326.      *   'if_primary_term'        => '(number) only perform the update operation if the last operation that has changed the document has the specified primary term',
  1327.      * ]
  1328.      * @return callable|array
  1329.      */
  1330.     public function update(array $params)
  1331.     {
  1332.         $id = $this->extractArgument($params, 'id');
  1333.         $index = $this->extractArgument($params, 'index');
  1334.         $type = $this->extractArgument($params, 'type');
  1335.         $body = $this->extractArgument($params, 'body');
  1337.         /**
  1338.  * @var callable $endpointBuilder
  1339. */
  1340.         $endpointBuilder = $this->endpoints;
  1342.         /**
  1343.  * @var \Elasticsearch\Endpoints\Update $endpoint
  1344. */
  1345.         $endpoint = $endpointBuilder('Update');
  1346.         $endpoint->setID($id)
  1347.             ->setIndex($index)
  1348.             ->setType($type)
  1349.             ->setBody($body);
  1350.         $endpoint->setParams($params);
  1352.         return $this->performRequest($endpoint);
  1353.     }
  1355.     /**
  1356.      * Endpoint: update_by_query
  1357.      *
  1358.      * @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html
  1359.      *
  1360.      * $params[
  1361.      *   'body'                   => '(string) The search definition using the Query DSL',
  1362.      *   'index'                  => '(list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices (Required)',
  1363.      *   'type'                   => '(list) A comma-separated list of document types to search; leave empty to perform the operation on all types',
  1364.      *   'analyzer'               => '(string) The analyzer to use for the query string',
  1365.      *   'analyze_wildcard'       => '(boolean) Specify whether wildcard and prefix queries should be analyzed (default: false)',
  1366.      *   'default_operator'       => '(enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR)',
  1367.      *   'df'                     => '(string) The field to use as default where no field prefix is given in the query string',
  1368.      *   'from'                   => '(number) Starting offset (default: 0)',
  1369.      *   'ignore_unavailable'     => '(boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)',
  1370.      *   '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)',
  1371.      *   'conflicts'              => '(enum) What to do when the update by query hits version conflicts? (Options = abort,proceed) (Default = abort)',
  1372.      *   'expand_wildcards'       => '(enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,none,all) (Default = open)',
  1373.      *   'lenient'                => '(boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored',
  1374.      *   'pipeline'               => '(string) Ingest pipeline to set on index requests made by this action. (default: none)',
  1375.      *   'preference'             => '(string) Specify the node or shard the operation should be performed on (default: random)',
  1376.      *   'q'                      => '(string) Query in the Lucene query string syntax',
  1377.      *   'routing'                => '(list) A comma-separated list of specific routing values',
  1378.      *   'scroll'                 => '(time) Specify how long a consistent view of the index should be maintained for scrolled search',
  1379.      *   'search_type'            => '(enum) Search operation type (Options = query_then_fetch,dfs_query_then_fetch)',
  1380.      *   'search_timeout'         => '(time) Explicit timeout for each search request. Defaults to no timeout.',
  1381.      *   'size'                   => '(number) Number of hits to return (default: 10)',
  1382.      *   'sort'                   => '(list) A comma-separated list of <field>:<direction> pairs',
  1383.      *   '_source'                => '(list) True or false to return the _source field or not, or a list of fields to return',
  1384.      *   '_source_excludes'       => '(list) A list of fields to exclude from the returned _source field',
  1385.      *   '_source_includes'       => '(list) A list of fields to extract and return from the _source field',
  1386.      *   'terminate_after'        => '(number) The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.',
  1387.      *   'stats'                  => '(list) Specific 'tag' of the request for logging and statistical purposes',
  1388.      *   'version'                => '(boolean) Specify whether to return document version as part of a hit',
  1389.      *   'version_type'           => '(boolean) Should the document increment the version number (internal) on hit or not (reindex)',
  1390.      *   'request_cache'          => '(boolean) Specify if request cache should be used for this request or not, defaults to index level setting',
  1391.      *   'refresh'                => '(boolean) Should the effected indexes be refreshed?',
  1392.      *   'timeout'                => '(time) Time each individual bulk request should wait for shards that are unavailable. (Default = 1m)',
  1393.      *   '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)',
  1394.      *   'scroll_size'            => '(number) Size on the scroll request powering the update by query',
  1395.      *   'wait_for_completion'    => '(boolean) Should the request should block until the update by query operation is complete. (Default = true)',
  1396.      *   'requests_per_second'    => '(number) The throttle to set on this request in sub-requests per second. -1 means no throttle. (Default = 0)',
  1397.      *   'slices'                 => '(number) The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks. (Default = 1)',
  1398.      * ]
  1399.      * @return callable|array
  1400.      */
  1401.     public function updateByQuery(array $params = [])
  1402.     {
  1403.         $index = $this->extractArgument($params, 'index');
  1404.         $body = $this->extractArgument($params, 'body');
  1405.         $type = $this->extractArgument($params, 'type');
  1407.         /**
  1408.  * @var callable $endpointBuilder
  1409. */
  1410.         $endpointBuilder = $this->endpoints;
  1412.         /**
  1413.  * @var \Elasticsearch\Endpoints\UpdateByQuery $endpoint
  1414. */
  1415.         $endpoint = $endpointBuilder('UpdateByQuery');
  1416.         $endpoint->setIndex($index)
  1417.             ->setType($type)
  1418.             ->setBody($body);
  1419.         $endpoint->setParams($params);
  1421.         return $this->performRequest($endpoint);
  1422.     }
  1424.     /**
  1425.      * Endpoint: update_by_query_rethrottle
  1426.      *
  1427.      * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html
  1428.      *
  1429.      * $params[
  1430.      *   'task_id'             => '(string) The task id to rethrottle (Required)',
  1431.      *   'requests_per_second' => '(number) The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (Required)',
  1432.      * ]
  1433.      * @return callable|array
  1434.      */
  1435.     public function updateByQueryRethrottle(array $params = [])
  1436.     {
  1437.         $taskId = $this->extractArgument($params, 'task_id');
  1439.         /**
  1440.  * @var callable $endpointBuilder
  1441. */
  1442.         $endpointBuilder = $this->endpoints;
  1444.         /**
  1445.  * @var \Elasticsearch\Endpoints\UpdateByQueryRethrottle $endpoint
  1446. */
  1447.         $endpoint = $endpointBuilder('UpdateByQueryRethrottle');
  1448.         $endpoint->setTaskId($taskId);
  1449.         $endpoint->setParams($params);
  1451.         return $this->performRequest($endpoint);
  1452.     }
  1454.     /**
  1455.      * Endpoint: get_script
  1456.      *
  1457.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html
  1458.      *
  1459.      * $params[
  1460.      *   'id'             => '(string) Script ID (Required)',
  1461.      *   'master_timeout' => '(time) Specify timeout for connection to master',
  1462.      * ]
  1463.      * @return callable|array
  1464.      */
  1465.     public function getScript(array $params)
  1466.     {
  1467.         $id = $this->extractArgument($params, 'id');
  1469.         /**
  1470.  * @var callable $endpointBuilder
  1471. */
  1472.         $endpointBuilder = $this->endpoints;
  1474.         /**
  1475.  * @var \Elasticsearch\Endpoints\Script\Get $endpoint
  1476. */
  1477.         $endpoint = $endpointBuilder('Script\Get');
  1478.         $endpoint->setID($id);
  1479.         $endpoint->setParams($params);
  1481.         return $this->performRequest($endpoint);
  1482.     }
  1484.     /**
  1485.      * Endpoint: delete_script
  1486.      *
  1487.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html
  1488.      *
  1489.      * $params[
  1490.      *   'id'             => '(string) Script ID (Required)',
  1491.      *   'timeout'        => '(time) Explicit operation timeout',
  1492.      *   'master_timeout' => '(time) Specify timeout for connection to master',
  1493.      * ]
  1494.      * @return callable|array
  1495.      */
  1496.     public function deleteScript(array $params)
  1497.     {
  1498.         $id = $this->extractArgument($params, 'id');
  1500.         /**
  1501.  * @var callable $endpointBuilder
  1502. */
  1503.         $endpointBuilder = $this->endpoints;
  1505.         /**
  1506.  * @var \Elasticsearch\Endpoints\Script\Delete $endpoint
  1507. */
  1508.         $endpoint = $endpointBuilder('Script\Delete');
  1509.         $endpoint->setID($id);
  1510.         $endpoint->setParams($params);
  1512.         return $this->performRequest($endpoint);
  1513.     }
  1515.     /**
  1516.      * Endpoint: put_script
  1517.      *
  1518.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html
  1519.      *
  1520.      * $params[
  1521.      *   'body'           => '(string) The document (Required)',
  1522.      *   'id'             => '(string) Script ID (Required)',
  1523.      *   'context'        => '(string) Script context',
  1524.      *   'timeout'        => '(time) Explicit operation timeout',
  1525.      *   'master_timeout' => '(time) Specify timeout for connection to master',
  1526.      *   'context'        => '(string) Context name to compile script against',
  1527.      * ]
  1528.      * @return callable|array
  1529.      */
  1530.     public function putScript(array $params)
  1531.     {
  1532.         $id   = $this->extractArgument($params, 'id');
  1533.         $body = $this->extractArgument($params, 'body');
  1535.         /**
  1536.  * @var callable $endpointBuilder
  1537. */
  1538.         $endpointBuilder = $this->endpoints;
  1540.         /**
  1541.  * @var \Elasticsearch\Endpoints\Script\Put $endpoint
  1542. */
  1543.         $endpoint = $endpointBuilder('Script\Put');
  1544.         $endpoint->setID($id)
  1545.             ->setBody($body);
  1546.         $endpoint->setParams($params);
  1548.         return $this->performRequest($endpoint);
  1549.     }
  1551.     /**
  1552.      * $params['id']   = (string) The search template ID (Required)
  1553.      *
  1554.      * @return callable|array
  1555.      */
  1556.     public function getTemplate(array $params)
  1557.     {
  1558.         $id = $this->extractArgument($params, 'id');
  1560.         /**
  1561.  * @var callable $endpointBuilder
  1562. */
  1563.         $endpointBuilder = $this->endpoints;
  1565.         /**
  1566.  * @var \Elasticsearch\Endpoints\Template\Get $endpoint
  1567. */
  1568.         $endpoint = $endpointBuilder('Template\Get');
  1569.         $endpoint->setID($id);
  1570.         $endpoint->setParams($params);
  1572.         return $this->performRequest($endpoint);
  1573.     }
  1575.     /**
  1576.      * $params['id']   = (string) The search template ID (Required)
  1577.      *
  1578.      * @return callable|array
  1579.      */
  1580.     public function deleteTemplate(array $params)
  1581.     {
  1582.         $id = $this->extractArgument($params, 'id');
  1584.         /**
  1585.  * @var callable $endpointBuilder
  1586. */
  1587.         $endpointBuilder = $this->endpoints;
  1589.         /**
  1590.  * @var \Elasticsearch\Endpoints\Template\Delete $endpoint
  1591. */
  1592.         $endpoint = $endpointBuilder('Template\Delete');
  1593.         $endpoint->setID($id);
  1594.         $endpoint->setParams($params);
  1596.         return $this->performRequest($endpoint);
  1597.     }
  1599.     /**
  1600.      * Endpoint: field_caps
  1601.      *
  1602.      * @see http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html
  1603.      *
  1604.      * $params[
  1605.      *   'index'              => '(list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices',
  1606.      *   'fields'             => '(list) A comma-separated list of field names',
  1607.      *   'ignore_unavailable' => '(boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)',
  1608.      *   '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)',
  1609.      *   'expand_wildcards'   => '(enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,none,all) (Default = open)',
  1610.      *   'include_unmapped'   => '(boolean) Indicates whether unmapped fields should be included in the response. (Default = false)',
  1611.      * ]
  1612.      * @return callable|array
  1613.      */
  1614.     public function fieldCaps(array $params = [])
  1615.     {
  1616.         $index = $this->extractArgument($params, 'index');
  1618.         /**
  1619.  * @var callable $endpointBuilder
  1620. */
  1621.         $endpointBuilder = $this->endpoints;
  1623.         /**
  1624.  * @var \Elasticsearch\Endpoints\FieldCaps $endpoint
  1625. */
  1626.         $endpoint = $endpointBuilder('FieldCaps');
  1627.         $endpoint->setIndex($index)
  1628.             ->setParams($params);
  1630.         return $this->performRequest($endpoint);
  1631.     }
  1633.     /**
  1634.      * Endpoint: render_search_template
  1635.      *
  1636.      * @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html
  1637.      *
  1638.      * $params[
  1639.      *   'body' => '(string) The search definition template and its params',
  1640.      *   'id'   => '(string) The id of the stored search template',
  1641.      * ]
  1642.      * @return callable|array
  1643.      */
  1644.     public function renderSearchTemplate(array $params = [])
  1645.     {
  1646.         $body = $this->extractArgument($params, 'body');
  1647.         $id   = $this->extractArgument($params, 'id');
  1649.         /**
  1650.  * @var callable $endpointBuilder
  1651. */
  1652.         $endpointBuilder = $this->endpoints;
  1654.         /**
  1655.  * @var \Elasticsearch\Endpoints\RenderSearchTemplate $endpoint
  1656. */
  1657.         $endpoint = $endpointBuilder('RenderSearchTemplate');
  1658.         $endpoint->setBody($body)
  1659.             ->setID($id);
  1660.         $endpoint->setParams($params);
  1662.         return $this->performRequest($endpoint);
  1663.     }
  1665.     /**
  1666.      * Operate on the Indices Namespace of commands
  1667.      */
  1668.     public function indices(): IndicesNamespace
  1669.     {
  1670.         return $this->indices;
  1671.     }
  1673.     /**
  1674.      * Operate on the Cluster namespace of commands
  1675.      */
  1676.     public function cluster(): ClusterNamespace
  1677.     {
  1678.         return $this->cluster;
  1679.     }
  1681.     /**
  1682.      * Operate on the Nodes namespace of commands
  1683.      */
  1684.     public function nodes(): NodesNamespace
  1685.     {
  1686.         return $this->nodes;
  1687.     }
  1689.     /**
  1690.      * Operate on the Snapshot namespace of commands
  1691.      */
  1692.     public function snapshot(): SnapshotNamespace
  1693.     {
  1694.         return $this->snapshot;
  1695.     }
  1697.     /**
  1698.      * Operate on the Cat namespace of commands
  1699.      */
  1700.     public function cat(): CatNamespace
  1701.     {
  1702.         return $this->cat;
  1703.     }
  1705.     /**
  1706.      * Operate on the Ingest namespace of commands
  1707.      */
  1708.     public function ingest(): IngestNamespace
  1709.     {
  1710.         return $this->ingest;
  1711.     }
  1713.     /**
  1714.      * Operate on the Tasks namespace of commands
  1715.      */
  1716.     public function tasks(): TasksNamespace
  1717.     {
  1718.         return $this->tasks;
  1719.     }
  1721.     /**
  1722.      * Catchall for registered namespaces
  1723.      *
  1724.      * @return object
  1725.      * @throws BadMethodCallException if the namespace cannot be found
  1726.      */
  1727.     public function __call(string $name, array $arguments)
  1728.     {
  1729.         if (isset($this->registeredNamespaces[$name])) {
  1730.             return $this->registeredNamespaces[$name];
  1731.         }
  1732.         throw new BadMethodCallException("Namespace [$name] not found");
  1733.     }
  1735.     /**
  1736.      * @return null|mixed
  1737.      */
  1738.     public function extractArgument(array &$params, string $arg)
  1739.     {
  1740.         if (array_key_exists($arg, $params) === true) {
  1741.             $value = $params[$arg];
  1742.             $value = is_object($value) ? (array) $value : $value;
  1743.             unset($params[$arg]);
  1744.             return $value;
  1745.         } else {
  1746.             return null;
  1747.         }
  1748.     }
  1750.     private function verifyNotNullOrEmpty(string $name, $var)
  1751.     {
  1752.         if ($var === null) {
  1753.             throw new InvalidArgumentException("$name cannot be null.");
  1754.         }
  1756.         if (is_string($var)) {
  1757.             if (strlen($var) === 0) {
  1758.                 throw new InvalidArgumentException("$name cannot be an empty string");
  1759.             }
  1760.         }
  1762.         if (is_array($var)) {
  1763.             if (strlen(implode("", $var)) === 0) {
  1764.                 throw new InvalidArgumentException("$name cannot be an array of empty strings");
  1765.             }
  1766.         }
  1767.     }
  1769.     /**
  1770.      * @return callable|array
  1771.      */
  1772.     private function performRequest(AbstractEndpoint $endpoint)
  1773.     {
  1774.         $promise =  $this->transport->performRequest(
  1775.             $endpoint->getMethod(),
  1776.             $endpoint->getURI(),
  1777.             $endpoint->getParams(),
  1778.             $endpoint->getBody(),
  1779.             $endpoint->getOptions()
  1780.         );
  1782.         return $this->transport->resultOrFuture($promise, $endpoint->getOptions());
  1783.     }
  1784. }