Properties
Optional _source
_source?: string | string[]
Optional _source_exclude
_source_exclude?: string | string[]
Optional _source_excludes
_source_excludes?: string | string[]
Optional _source_include
_source_include?: string | string[]
Optional _source_includes
_source_includes?: string | string[]
Optional allow_no_indices
allow_no_indices?: boolean
Optional allow_partial_search_results
allow_partial_search_results?: boolean
Optional analyze_wildcard
analyze_wildcard?: boolean
Optional analyzer
analyzer?: string
Optional batched_reduce_size
batched_reduce_size?: number
Optional body
body?: T
Optional default_operator
default_operator?: "AND" | "OR"
Optional df
df?: string
Optional docvalue_fields
docvalue_fields?: string | string[]
Optional error_trace
error_trace?: boolean
Optional expand_wildcards
expand_wildcards?: "all" | "none" | "closed" | "open" | "hidden"
Optional explain
explain?: boolean
Optional filter_path
filter_path?: string | string[]
Optional from
from?: number
Optional human
human?: boolean
Optional ignore_throttled
ignore_throttled?: boolean
Optional ignore_unavailable
ignore_unavailable?: boolean
Optional index
index?: string | string[]
Optional keep_alive
keep_alive?: string
Optional keep_on_completion
keep_on_completion?: boolean
Optional lenient
lenient?: boolean
Optional max_concurrent_shard_requests
max_concurrent_shard_requests?: number
Optional method
method?: string
Optional preference
preference?: string
Optional pretty
pretty?: boolean
Optional q
q?: string
Optional request_cache
request_cache?: boolean
Optional routing
routing?: string | string[]
Optional search_type
search_type?: "query_then_fetch" | "dfs_query_then_fetch"
Optional seq_no_primary_term
seq_no_primary_term?: boolean
Optional size
size?: number
Optional sort
sort?: string | string[]
Optional source
source?: string
Optional stats
stats?: string | string[]
Optional stored_fields
stored_fields?: string | string[]
Optional suggest_field
suggest_field?: string
Optional suggest_mode
suggest_mode?: "always" | "missing" | "popular"
Optional suggest_size
suggest_size?: number
Optional suggest_text
suggest_text?: string
Optional terminate_after
terminate_after?: number
Optional timeout
timeout?: string
Optional track_scores
track_scores?: boolean
Optional track_total_hits
track_total_hits?: boolean
Optional typed_keys
typed_keys?: boolean
Optional version
version?: boolean
Optional wait_for_completion_timeout
wait_for_completion_timeout?: string