78 lines
4.6 KiB
Plaintext
78 lines
4.6 KiB
Plaintext
[[reference-eql-search]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| 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.search
|
|
|
|
Returns results matching a query expressed in Event Query Language (EQL)
|
|
|
|
{ref}/eql-search-api.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(EqlSearchRequest, options?): Promise<EqlSearchResponse>
|
|
----
|
|
|
|
[discrete]
|
|
===== `EqlSearchRequest`
|
|
|
|
[source,ts]
|
|
----
|
|
interface EqlSearchRequest extends <<shared-type-request-base, RequestBase>> {
|
|
index: <<shared-type-indices, Indices>>
|
|
allow_no_indices?: boolean
|
|
expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
|
|
ignore_unavailable?: boolean
|
|
query: string
|
|
case_sensitive?: boolean
|
|
event_category_field?: <<shared-type-field, Field>>
|
|
tiebreaker_field?: <<shared-type-field, Field>>
|
|
timestamp_field?: <<shared-type-field, Field>>
|
|
fetch_size?: <<shared-type-uint, uint>>
|
|
filter?: QueryDslQueryContainer | QueryDslQueryContainer[]
|
|
keep_alive?: <<shared-type-duration, Duration>>
|
|
keep_on_completion?: boolean
|
|
wait_for_completion_timeout?: <<shared-type-duration, Duration>>
|
|
size?: <<shared-type-uint, uint>>
|
|
fields?: QueryDslFieldAndFormat | <<shared-type-field, Field>> | (QueryDslFieldAndFormat | <<shared-type-field, Field>>)[]
|
|
result_position?: EqlSearchResultPosition
|
|
runtime_mappings?: MappingRuntimeFields
|
|
}
|
|
----
|
|
|
|
[discrete]
|
|
===== `EqlSearchResponse`
|
|
|
|
[source,ts]
|
|
----
|
|
type EqlSearchResponse<TEvent = unknown> = EqlEqlSearchResponseBase<TEvent>
|
|
----
|
|
|