Types: `Elasticsearch Client Elasticsearch Params Search Params`
elasticsearch-client/elasticsearch-params.SearchParams
Table of contents
Properties
- _source
- _source_excludes
- _source_includes
- allow_no_indices
- allow_partial_search_results
- analyze_wildcard
- analyzer
- batched_reduce_size
- body
- ccs_minimize_roundtrips
- default_operator
- df
- docvalue_fields
- expand_wildcards
- explain
- from
- ignore
- ignore_throttled
- ignore_unavailable
- index
- lenient
- max_concurrent_shard_requests
- min_compatible_shard_node
- pre_filter_shard_size
- preference
- q
- request_cache
- rest_total_hits_as_int
- routing
- scroll
- search_type
- seq_no_primary_term
- size
- sort
- stats
- stored_fields
- suggest_field
- suggest_mode
- suggest_size
- suggest_text
- terminate_after
- timeout
- track_scores
- track_total_hits
- type
- typed_keys
- version
Properties
_source
• Optional
_source: string
| boolean
| string
[]
Defined in
elasticsearch-client/elasticsearch-params.ts:388
_source_excludes
• Optional
_source_excludes: string
| string
[]
Defined in
elasticsearch-client/elasticsearch-params.ts:389
_source_includes
• Optional
_source_includes: string
| string
[]
Defined in
elasticsearch-client/elasticsearch-params.ts:390
allow_no_indices
• Optional
allow_no_indices: boolean
Defined in
elasticsearch-client/elasticsearch-params.ts:357
allow_partial_search_results
• Optional
allow_partial_search_results: boolean
Defined in
elasticsearch-client/elasticsearch-params.ts:358
analyze_wildcard
• Optional
analyze_wildcard: boolean
Defined in
elasticsearch-client/elasticsearch-params.ts:360
analyzer
• Optional
analyzer: string
Defined in
elasticsearch-client/elasticsearch-params.ts:359
batched_reduce_size
• Optional
batched_reduce_size: number
Defined in
elasticsearch-client/elasticsearch-params.ts:361
body
• Optional
body: Record
<string
, any
>
Defined in
elasticsearch-client/elasticsearch-params.ts:362
ccs_minimize_roundtrips
• Optional
ccs_minimize_roundtrips: boolean
Defined in
elasticsearch-client/elasticsearch-params.ts:363
default_operator
• Optional
default_operator: string
Defined in
elasticsearch-client/elasticsearch-params.ts:364
df
• Optional
df: string
Defined in
elasticsearch-client/elasticsearch-params.ts:365
docvalue_fields
• Optional
docvalue_fields: string
Defined in
elasticsearch-client/elasticsearch-params.ts:366
expand_wildcards
• Optional
expand_wildcards: ExpandWildcards
Defined in
elasticsearch-client/elasticsearch-params.ts:367
explain
• Optional
explain: boolean
Defined in
elasticsearch-client/elasticsearch-params.ts:368
from
• Optional
from: number
Defined in
elasticsearch-client/elasticsearch-params.ts:369
ignore
• Optional
ignore: number
| number
[]
Defined in
elasticsearch-client/elasticsearch-params.ts:371
ignore_throttled
• Optional
ignore_throttled: boolean
Defined in
elasticsearch-client/elasticsearch-params.ts:372
ignore_unavailable
• Optional
ignore_unavailable: boolean
Defined in
elasticsearch-client/elasticsearch-params.ts:373
index
• Optional
index: string
| string
[]
Defined in
elasticsearch-client/elasticsearch-params.ts:370
lenient
• Optional
lenient: boolean
Defined in
elasticsearch-client/elasticsearch-params.ts:374
max_concurrent_shard_requests
• Optional
max_concurrent_shard_requests: number
Defined in
elasticsearch-client/elasticsearch-params.ts:375
min_compatible_shard_node
• Optional
min_compatible_shard_node: string
Defined in
elasticsearch-client/elasticsearch-params.ts:376
pre_filter_shard_size
• Optional
pre_filter_shard_size: number
Defined in
elasticsearch-client/elasticsearch-params.ts:377
preference
• Optional
preference: string
Defined in
elasticsearch-client/elasticsearch-params.ts:378
q
• Optional
q: string
Defined in
elasticsearch-client/elasticsearch-params.ts:379
request_cache
• Optional
request_cache: boolean
Defined in
elasticsearch-client/elasticsearch-params.ts:380
rest_total_hits_as_int
• Optional
rest_total_hits_as_int: boolean
Defined in
elasticsearch-client/elasticsearch-params.ts:381
routing
• Optional
routing: string
| string
[]
Defined in
elasticsearch-client/elasticsearch-params.ts:382
scroll
• Optional
scroll: `${number}m` | `${number}d` | `${number}h` | `${number}s` | `${number}ms` | `${number}micros` | `${number}nanos`
Defined in
elasticsearch-client/elasticsearch-params.ts:383
search_type
• Optional
search_type: SearchTypes
Defined in
elasticsearch-client/elasticsearch-params.ts:384
seq_no_primary_term
• Optional
seq_no_primary_term: boolean
Defined in
elasticsearch-client/elasticsearch-params.ts:385
size
• Optional
size: number
Defined in
elasticsearch-client/elasticsearch-params.ts:386
sort
• Optional
sort: string
Defined in
elasticsearch-client/elasticsearch-params.ts:387
stats
• Optional
stats: string
| string
[]
Defined in
elasticsearch-client/elasticsearch-params.ts:391
stored_fields
• Optional
stored_fields: string
Defined in
elasticsearch-client/elasticsearch-params.ts:392
suggest_field
• Optional
suggest_field: string
Defined in
elasticsearch-client/elasticsearch-params.ts:393
suggest_mode
• Optional
suggest_mode: SuggestMode
Defined in
elasticsearch-client/elasticsearch-params.ts:394
suggest_size
• Optional
suggest_size: number
Defined in
elasticsearch-client/elasticsearch-params.ts:395
suggest_text
• Optional
suggest_text: string
Defined in
elasticsearch-client/elasticsearch-params.ts:396
terminate_after
• Optional
terminate_after: number
Defined in
elasticsearch-client/elasticsearch-params.ts:397
timeout
• Optional
timeout: `${number}m` | `${number}d` | `${number}h` | `${number}s` | `${number}ms` | `${number}micros` | `${number}nanos`
Defined in
elasticsearch-client/elasticsearch-params.ts:398
track_scores
• Optional
track_scores: boolean
Defined in
elasticsearch-client/elasticsearch-params.ts:399
track_total_hits
• Optional
track_total_hits: number
| boolean
Defined in
elasticsearch-client/elasticsearch-params.ts:400
type
• Optional
type: string
Defined in
elasticsearch-client/elasticsearch-params.ts:401
typed_keys
• Optional
typed_keys: boolean
Defined in
elasticsearch-client/elasticsearch-params.ts:402
version
• Optional
version: boolean