Lines Matching defs:params
33 * $params['id'] = (string) The async search ID
35 * @param array $params Associative array of parameters
39 public function delete(array $params = [])
41 $id = $this->extractArgument($params, 'id');
45 $endpoint->setParams($params);
53 * $params['id'] = (string) The async search ID
54 * $params['wait_for_completion_timeout'] = (time) Specify the time that the request should block waiting for the final response
55 * $params['keep_alive'] = (time) Specify the time interval in which the results (partial or final) for this search will be available
56 * $params['typed_keys'] = (boolean) Specify whether aggregation and suggester names should be prefixed by their respective types in the response
58 * @param array $params Associative array of parameters
62 public function get(array $params = [])
64 $id = $this->extractArgument($params, 'id');
68 $endpoint->setParams($params);
76 * $params['id'] = (string) The async search ID
78 * @param array $params Associative array of parameters
82 public function status(array $params = [])
84 $id = $this->extractArgument($params, 'id');
88 $endpoint->setParams($params);
96 * $params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
97 * $params['wait_for_completion_timeout'] = (time) Specify the time that the request should block waiting for the final response (Default = 1s)
98 * $params['keep_on_completion'] = (boolean) Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false) (Default = false)
99 * $params['keep_alive'] = (time) Update the time interval in which the results (partial or final) for this search will be available (Default = 5d)
100 * $params['batched_reduce_size'] = (number) The number of shard results that should be reduced at once on the coordinating node. This value should be used as the granularity at which progress results will be made available. (Default = 5)
101 * $params['request_cache'] = (boolean) Specify if request cache should be used for this request or not, defaults to true
102 * $params['analyzer'] = (string) The analyzer to use for the query string
103 * $params['analyze_wildcard'] = (boolean) Specify whether wildcard and prefix queries should be analyzed (default: false)
104 * $params['default_operator'] = (enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR)
105 * $params['df'] = (string) The field to use as default where no field prefix is given in the query string
106 * $params['explain'] = (boolean) Specify whether to return detailed information about score computation as part of a hit
107 * $params['stored_fields'] = (list) A comma-separated list of stored fields to return as part of a hit
108 * $params['docvalue_fields'] = (list) A comma-separated list of fields to return as the docvalue representation of a field for each hit
109 * $params['from'] = (number) Starting offset (default: 0)
110 * $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
111 * $params['ignore_throttled'] = (boolean) Whether specified concrete, expanded or aliased indices should be ignored when throttled
112 * $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
113 * $params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open)
114 * $params['lenient'] = (boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
115 * $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
116 * $params['q'] = (string) Query in the Lucene query string syntax
117 * $params['routing'] = (list) A comma-separated list of specific routing values
118 * $params['search_type'] = (enum) Search operation type (Options = query_then_fetch,dfs_query_then_fetch)
119 * $params['size'] = (number) Number of hits to return (default: 10)
120 * $params['sort'] = (list) A comma-separated list of <field>:<direction> pairs
121 * $params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
122 * $params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
123 * $params['_source_includes'] = (list) A list of fields to extract and return from the _source field
124 * $params['terminate_after'] = (number) The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
125 * $params['stats'] = (list) Specific 'tag' of the request for logging and statistical purposes
126 * $params['suggest_field'] = (string) Specify which field to use for suggestions
127 * $params['suggest_mode'] = (enum) Specify suggest mode (Options = missing,popular,always) (Default = missing)
128 * $params['suggest_size'] = (number) How many suggestions to return in response
129 * $params['suggest_text'] = (string) The source text for which the suggestions should be returned
130 * $params['timeout'] = (time) Explicit operation timeout
131 * $params['track_scores'] = (boolean) Whether to calculate and return scores even if they are not used for sorting
132 * $params['track_total_hits'] = (boolean) Indicate if the number of documents that match the query should be tracked
133 * $params['allow_partial_search_results'] = (boolean) Indicate if an error should be returned if there is a partial search failure or timeout (Default = true)
134 * $params['typed_keys'] = (boolean) Specify whether aggregation and suggester names should be prefixed by their respective types in the response
135 * $params['version'] = (boolean) Specify whether to return document version as part of a hit
136 * $params['seq_no_primary_term'] = (boolean) Specify whether to return sequence number and primary term of the last modification of each hit
137 * $params['max_concurrent_shard_requests'] = (number) The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests (Default = 5)
138 * $params['body'] = (array) The search definition using the Query DSL
140 * @param array $params Associative array of parameters
144 public function submit(array $params = [])
146 $index = $this->extractArgument($params, 'index');
147 $body = $this->extractArgument($params, 'body');
151 $endpoint->setParams($params);