[[reference-fleet-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 || || || || || || || =========================================================================================================================== //////// [discrete] [[client.fleet.search]] === client.fleet.search The purpose of the fleet search api is to provide a search api where the search will only be executed after provided checkpoint has been processed and is visible for searches inside of Elasticsearch. [discrete] ==== Function signature [source,ts] ---- (FleetSearchRequest, options?): Promise ---- [discrete] ==== FleetSearchRequest [pass] ++++ 
++++
interface FleetSearchRequest extends <> {
  index: <> | <>
  allow_no_indices?: boolean
  analyzer?: string
  analyze_wildcard?: boolean
  batched_reduce_size?: <>
  ccs_minimize_roundtrips?: boolean
  default_operator?: <>
  df?: string
  expand_wildcards?: <>
  ignore_throttled?: boolean
  ignore_unavailable?: boolean
  lenient?: boolean
  max_concurrent_shard_requests?: <>
  min_compatible_shard_node?: <>
  preference?: string
  pre_filter_shard_size?: <>
  request_cache?: boolean
  routing?: <>
  scroll?: <>
  search_type?: <>
  suggest_field?: <>
  suggest_mode?: <>
  suggest_size?: <>
  suggest_text?: string
  typed_keys?: boolean
  rest_total_hits_as_int?: boolean
  _source_excludes?: <>
  _source_includes?: <>
  q?: string
  wait_for_checkpoints?: <>[]
  allow_partial_search_results?: boolean
  aggregations?: Record>>
  pass:[/**] @alias aggregations */
  aggs?: Record>>
  collapse?: <>
  explain?: boolean
  ext?: Record
  from?: <>
  highlight?: <>
  track_total_hits?: <>
  indices_boost?: Record<<>, <>>[]
  docvalue_fields?: (<> | <>)[]
  min_score?: <>
  post_filter?: <>
  profile?: boolean
  query?: <>
  rescore?: <> | <>[]
  script_fields?: Record>>
  search_after?: <>
  size?: <>
  slice?: <>
  sort?: <>
  _source?: <>
  fields?: (<> | <>)[]
  suggest?: <>
  terminate_after?: <>
  timeout?: string
  track_scores?: boolean
  version?: boolean
  seq_no_primary_term?: boolean
  stored_fields?: <>
  pit?: <>
  runtime_mappings?: <>
  stats?: string[]
}

[pass]
++++
++++ [discrete] ==== FleetSearchResponse [pass] ++++ 
++++
interface FleetSearchResponse {
  took: <>
  timed_out: boolean
  _shards: <>
  hits: <>
  aggregations?: Record<<>, <>>
  _clusters?: <>
  fields?: Record
  max_score?: <>
  num_reduce_phases?: <>
  profile?: <>
  pit_id?: <>
  _scroll_id?: <>
  suggest?: Record<<>, <>[]>
  terminated_early?: boolean
}

[pass]
++++
++++