1
2
3[[Elasticsearch_Namespaces_AsyncSearchNamespace]]
4=== Elasticsearch\Namespaces\AsyncSearchNamespace
5
6
7
8Class AsyncSearchNamespace
9
10*Description*
11
12
13NOTE: this file is autogenerated using util/GenerateEndpoints.php
14and Elasticsearch 7.12.1 (3186837139b9c6b6d23c3200870651f10d3343b7)
15
16
17*Methods*
18
19The class defines the following methods:
20
21* <<Elasticsearch_Namespaces_AsyncSearchNamespacedelete_delete,`delete()`>>
22* <<Elasticsearch_Namespaces_AsyncSearchNamespaceget_get,`get()`>>
23* <<Elasticsearch_Namespaces_AsyncSearchNamespacestatus_status,`status()`>>
24* <<Elasticsearch_Namespaces_AsyncSearchNamespacesubmit_submit,`submit()`>>
25
26
27
28[[Elasticsearch_Namespaces_AsyncSearchNamespacedelete_delete]]
29.`delete(array $params = [])`
30****
31[source,php]
32----
33/*
34$params['id'] = (string) The async search ID
35*/
36----
37****
38
39
40
41[[Elasticsearch_Namespaces_AsyncSearchNamespaceget_get]]
42.`get(array $params = [])`
43****
44[source,php]
45----
46/*
47$params['id']                          = (string) The async search ID
48$params['wait_for_completion_timeout'] = (time) Specify the time that the request should block waiting for the final response
49$params['keep_alive']                  = (time) Specify the time interval in which the results (partial or final) for this search will be available
50$params['typed_keys']                  = (boolean) Specify whether aggregation and suggester names should be prefixed by their respective types in the response
51*/
52----
53****
54
55
56
57[[Elasticsearch_Namespaces_AsyncSearchNamespacestatus_status]]
58.`status(array $params = [])`
59****
60[source,php]
61----
62/*
63$params['id'] = (string) The async search ID
64*/
65----
66****
67
68
69
70[[Elasticsearch_Namespaces_AsyncSearchNamespacesubmit_submit]]
71.`submit(array $params = [])`
72****
73[source,php]
74----
75/*
76$params['index']                         = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
77$params['wait_for_completion_timeout']   = (time) Specify the time that the request should block waiting for the final response (Default = 1s)
78$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)
79$params['keep_alive']                    = (time) Update the time interval in which the results (partial or final) for this search will be available (Default = 5d)
80$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)
81$params['request_cache']                 = (boolean) Specify if request cache should be used for this request or not, defaults to true
82$params['analyzer']                      = (string) The analyzer to use for the query string
83$params['analyze_wildcard']              = (boolean) Specify whether wildcard and prefix queries should be analyzed (default: false)
84$params['default_operator']              = (enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR)
85$params['df']                            = (string) The field to use as default where no field prefix is given in the query string
86$params['explain']                       = (boolean) Specify whether to return detailed information about score computation as part of a hit
87$params['stored_fields']                 = (list) A comma-separated list of stored fields to return as part of a hit
88$params['docvalue_fields']               = (list) A comma-separated list of fields to return as the docvalue representation of a field for each hit
89$params['from']                          = (number) Starting offset (default: 0)
90$params['ignore_unavailable']            = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
91$params['ignore_throttled']              = (boolean) Whether specified concrete, expanded or aliased indices should be ignored when throttled
92$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)
93$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)
94$params['lenient']                       = (boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
95$params['preference']                    = (string) Specify the node or shard the operation should be performed on (default: random)
96$params['q']                             = (string) Query in the Lucene query string syntax
97$params['routing']                       = (list) A comma-separated list of specific routing values
98$params['search_type']                   = (enum) Search operation type (Options = query_then_fetch,dfs_query_then_fetch)
99$params['size']                          = (number) Number of hits to return (default: 10)
100$params['sort']                          = (list) A comma-separated list of <field>:<direction> pairs
101$params['_source']                       = (list) True or false to return the _source field or not, or a list of fields to return
102$params['_source_excludes']              = (list) A list of fields to exclude from the returned _source field
103$params['_source_includes']              = (list) A list of fields to extract and return from the _source field
104$params['terminate_after']               = (number) The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
105*/
106----
107****
108
109
110