1
2
3[[Elasticsearch_Namespaces_EqlNamespace]]
4=== Elasticsearch\Namespaces\EqlNamespace
5
6
7
8Class EqlNamespace
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_EqlNamespacedelete_delete,`delete()`>>
22* <<Elasticsearch_Namespaces_EqlNamespaceget_get,`get()`>>
23* <<Elasticsearch_Namespaces_EqlNamespacegetStatus_getStatus,`getStatus()`>>
24* <<Elasticsearch_Namespaces_EqlNamespacesearch_search,`search()`>>
25
26
27
28[[Elasticsearch_Namespaces_EqlNamespacedelete_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_EqlNamespaceget_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) Update the time interval in which the results (partial or final) for this search will be available (Default = 5d)
50*/
51----
52****
53
54
55
56[[Elasticsearch_Namespaces_EqlNamespacegetStatus_getStatus]]
57.`getStatus(array $params = [])`
58****
59[source,php]
60----
61/*
62$params['id'] = (string) The async search ID
63*/
64----
65****
66
67
68
69[[Elasticsearch_Namespaces_EqlNamespacesearch_search]]
70.`search(array $params = [])`
71****
72[source,php]
73----
74/*
75$params['index']                       = (string) The name of the index to scope the operation
76$params['wait_for_completion_timeout'] = (time) Specify the time that the request should block waiting for the final response
77$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)
78$params['keep_alive']                  = (time) Update the time interval in which the results (partial or final) for this search will be available (Default = 5d)
79$params['body']                        = (array) Eql request body. Use the `query` to limit the query scope. (Required)
80*/
81----
82****
83
84
85