Files
elasticsearch-js/docs/reference-eql-get.asciidoc
2024-12-05 14:46:46 -06:00

63 lines
3.9 KiB
Plaintext

[[reference-eql-get]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[discrete]
=== client.eql.get
Returns the current status and available results for an async EQL search or a stored synchronous EQL search.
{ref}/get-async-eql-search-api.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(EqlGetRequest, options?): Promise<EqlGetResponse>
----
[discrete]
===== `EqlGetRequest`
[source,ts]
----
interface EqlGetRequest extends <<shared-type-request-base, RequestBase>> {
id: <<shared-type-id, Id>>
keep_alive?: <<shared-type-duration, Duration>>
wait_for_completion_timeout?: <<shared-type-duration, Duration>>
}
----
[discrete]
===== `EqlGetResponse`
[source,ts]
----
type EqlGetResponse<TEvent = unknown> = EqlEqlSearchResponseBase<TEvent>
----