86 lines
4.6 KiB
Plaintext
86 lines
4.6 KiB
Plaintext
[[reference-fleet-msearch]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| 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.fleet.msearch]]
|
|
=== client.fleet.msearch
|
|
|
|
Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request. The API follows the same structure as the [multi search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html) API. However, similar to the fleet search API, it supports the wait_for_checkpoints parameter.
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(FleetMsearchRequest, options?): Promise<FleetMsearchResponse>
|
|
----
|
|
|
|
[discrete]
|
|
==== Request
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface FleetMsearchRequest extends <<RequestBase>> {
|
|
index?: <<IndexName>> | <<IndexAlias>>
|
|
allow_no_indices?: boolean
|
|
ccs_minimize_roundtrips?: boolean
|
|
expand_wildcards?: <<ExpandWildcards>>
|
|
ignore_throttled?: boolean
|
|
ignore_unavailable?: boolean
|
|
max_concurrent_searches?: <<long>>
|
|
max_concurrent_shard_requests?: <<long>>
|
|
pre_filter_shard_size?: <<long>>
|
|
search_type?: <<SearchType>>
|
|
rest_total_hits_as_int?: boolean
|
|
typed_keys?: boolean
|
|
wait_for_checkpoints?: <<FleetCheckpoint>>[]
|
|
allow_partial_search_results?: boolean
|
|
searches?: <<MsearchRequestItem>>[]
|
|
}
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|
|
[discrete]
|
|
==== Response
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface FleetMsearchResponse<TDocument = unknown> {
|
|
docs: <<MsearchResponseItem>><TDocument>[]
|
|
}
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|