EqlNamespace.asciidoc 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. [[Elasticsearch_Namespaces_EqlNamespace]]
  2. === Elasticsearch\Namespaces\EqlNamespace
  3. Class EqlNamespace
  4. *Description*
  5. NOTE: this file is autogenerated using util/GenerateEndpoints.php
  6. and Elasticsearch 7.12.1 (3186837139b9c6b6d23c3200870651f10d3343b7)
  7. *Methods*
  8. The class defines the following methods:
  9. * <<Elasticsearch_Namespaces_EqlNamespacedelete_delete,`delete()`>>
  10. * <<Elasticsearch_Namespaces_EqlNamespaceget_get,`get()`>>
  11. * <<Elasticsearch_Namespaces_EqlNamespacegetStatus_getStatus,`getStatus()`>>
  12. * <<Elasticsearch_Namespaces_EqlNamespacesearch_search,`search()`>>
  13. [[Elasticsearch_Namespaces_EqlNamespacedelete_delete]]
  14. .`delete(array $params = [])`
  15. ****
  16. [source,php]
  17. ----
  18. /*
  19. $params['id'] = (string) The async search ID
  20. */
  21. ----
  22. ****
  23. [[Elasticsearch_Namespaces_EqlNamespaceget_get]]
  24. .`get(array $params = [])`
  25. ****
  26. [source,php]
  27. ----
  28. /*
  29. $params['id'] = (string) The async search ID
  30. $params['wait_for_completion_timeout'] = (time) Specify the time that the request should block waiting for the final response
  31. $params['keep_alive'] = (time) Update the time interval in which the results (partial or final) for this search will be available (Default = 5d)
  32. */
  33. ----
  34. ****
  35. [[Elasticsearch_Namespaces_EqlNamespacegetStatus_getStatus]]
  36. .`getStatus(array $params = [])`
  37. ****
  38. [source,php]
  39. ----
  40. /*
  41. $params['id'] = (string) The async search ID
  42. */
  43. ----
  44. ****
  45. [[Elasticsearch_Namespaces_EqlNamespacesearch_search]]
  46. .`search(array $params = [])`
  47. ****
  48. [source,php]
  49. ----
  50. /*
  51. $params['index'] = (string) The name of the index to scope the operation
  52. $params['wait_for_completion_timeout'] = (time) Specify the time that the request should block waiting for the final response
  53. $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)
  54. $params['keep_alive'] = (time) Update the time interval in which the results (partial or final) for this search will be available (Default = 5d)
  55. $params['body'] = (array) Eql request body. Use the `query` to limit the query scope. (Required)
  56. */
  57. ----
  58. ****