68 lines
4.2 KiB
Plaintext
68 lines
4.2 KiB
Plaintext
[[reference-eql-get_status]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| 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.getStatus
|
|
|
|
Returns the current status for an async EQL search or a stored synchronous EQL search without returning results.
|
|
|
|
{ref}/get-async-eql-status-api.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(EqlGetStatusRequest, options?): Promise<EqlGetStatusResponse>
|
|
----
|
|
|
|
[discrete]
|
|
===== `EqlGetStatusRequest`
|
|
|
|
[source,ts]
|
|
----
|
|
interface EqlGetStatusRequest extends <<shared-type-request-base, RequestBase>> {
|
|
id: <<shared-type-id, Id>>
|
|
}
|
|
----
|
|
|
|
[discrete]
|
|
===== `EqlGetStatusResponse`
|
|
|
|
[source,ts]
|
|
----
|
|
interface EqlGetStatusResponse {
|
|
id: <<shared-type-id, Id>>
|
|
is_partial: boolean
|
|
is_running: boolean
|
|
start_time_in_millis?: <<shared-type-epoch-time, EpochTime>><<<shared-type-unit-millis, UnitMillis>>>
|
|
expiration_time_in_millis?: <<shared-type-epoch-time, EpochTime>><<<shared-type-unit-millis, UnitMillis>>>
|
|
completion_status?: <<shared-type-integer, integer>>
|
|
}
|
|
----
|
|
|