habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Test run of new docs

Browse Source
This commit is contained in:
Josh Mock
2024-11-19 11:04:35 -06:00
parent f33aa8cccd
commit 8210607de0
503 changed files with 37166 additions and 12056 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
docs/reference-fleet-msearch.asciidoc Normal file
View File

@ -0,0 +1,74 @@
[[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
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]
===== `FleetMsearchRequest`
[source,ts]
----
interface FleetMsearchRequest extends <<shared-type-request-base, RequestBase>> {
index?: <<shared-type-index-name, IndexName>> | <<shared-type-index-alias, IndexAlias>>
allow_no_indices?: boolean
ccs_minimize_roundtrips?: boolean
expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
ignore_throttled?: boolean
ignore_unavailable?: boolean
max_concurrent_searches?: <<shared-type-long, long>>
max_concurrent_shard_requests?: <<shared-type-long, long>>
pre_filter_shard_size?: <<shared-type-long, long>>
search_type?: <<shared-type-search-type, SearchType>>
rest_total_hits_as_int?: boolean
typed_keys?: boolean
wait_for_checkpoints?: FleetCheckpoint[]
allow_partial_search_results?: boolean
searches?: MsearchRequestItem[]
}
----
[discrete]
===== `FleetMsearchResponse`
[source,ts]
----
interface FleetMsearchResponse<TDocument = unknown> {
docs: MsearchResponseItem<TDocument>[]
}
----