Class SearchRequest
- All Implemented Interfaces:
JsonpSerializable
q
query string parameter or the
request body. If both are specified, only the query parameter is used.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<SearchRequest>
Json deserializer forSearchRequest
static final SimpleEndpoint<SearchRequest,
?> Endpoint "search
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Map<String,
Aggregation> Defines the aggregations that are run as part of the search request.final Boolean
Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices.final Boolean
If true, returns partial results if there are shard request timeouts or shard failures.final String
analyzer()
Analyzer to use for the query string.final Boolean
If true, wildcard and prefix queries are analyzed.final Long
The number of shard results that should be reduced at once on the coordinating node.final Boolean
If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests.final FieldCollapse
collapse()
Collapses search results the values of the specified field.static <TDocument>
Endpoint<SearchRequest,SearchResponse<TDocument>, ErrorResponse> createSearchEndpoint
(JsonpDeserializer<TDocument> tDocumentDeserializer) Create an "search
" endpoint.final Operator
The default operator for query string query: AND or OR.final String
df()
Field to use as default where no field prefix is given in the query string.final List<FieldAndFormat>
Array of wildcard (*
) patterns.final List<ExpandWildcard>
Type of index that wildcard patterns can match.final Boolean
explain()
If true, returns detailed information about score computation as part of a hit.ext()
Configuration of search extensions defined by Elasticsearch plugins.final List<FieldAndFormat>
fields()
Array of wildcard (*
) patterns.final Integer
from()
Starting document offset.final Highlight
Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.final Boolean
Iftrue
, concrete, expanded or aliased indices will be ignored when frozen.final Boolean
Iffalse
, the request returns an error if it targets a missing or closed index.index()
Comma-separated list of data streams, indices, and aliases to search.Boosts the _score of documents from specified indices.knn()
Defines the approximate kNN search to run.final Boolean
lenient()
Iftrue
, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.final Long
Defines the number of concurrent shard requests per node this search executes concurrently.final String
The minimum version of the node that can handle the request Any handling node with a lower version will fail the request.final Double
minScore()
Minimum_score
for matching documents.static SearchRequest
final PointInTimeReference
pit()
Limits the search to a point in time (PIT).final Query
Use thepost_filter
parameter to filter search results.final String
Nodes and shards used for the search.final Long
Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold.final Boolean
profile()
Set totrue
to return detailed timing information about the execution of individual components in a search request.final String
q()
Query in the Lucene query string syntax using query parameter search.final Query
query()
Defines the search definition using the Query DSL.final Rank
rank()
Defines the Reciprocal Rank Fusion (RRF) to use.final Boolean
Iftrue
, the caching of search results is enabled for requests wheresize
is0
.rescore()
Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by thequery
andpost_filter
phases.final String
routing()
Custom value used to route operations to a specific shard.final Map<String,
RuntimeField> Defines one or more runtime fields in the search request.final Map<String,
ScriptField> Retrieve a script evaluation (based on different fields) for each hit.final Time
scroll()
Period to retain the search context for scrolling.final List<FieldValue>
Used to retrieve the next page of hits using a set of sort values from the previous page.final SearchType
How distributed term frequencies are calculated for relevance scoring.final Boolean
Iftrue
, returns sequence number and primary term of the last modification of each hit.void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
final Integer
size()
The number of hits to return.final SlicedScroll
slice()
Can be used to split a scrolled search into multiple slices that can be consumed independently.final List<SortOptions>
sort()
A comma-separated list of <field>:<direction> pairs.final SourceConfig
source()
Indicates which source fields are returned for matching documents.stats()
Stats groups to associate with the search.List of stored fields to return as part of a hit.final Suggester
suggest()
Defines a suggester that provides similar looking terms based on a provided text.final Long
Maximum number of documents to collect for each shard.final String
timeout()
Specifies the period of time to wait for a response from each shard.final Boolean
If true, calculate and return document scores, even if the scores are not used for sorting.final TrackHits
Number of hits matching the query to count accurately.final Boolean
version()
If true, returns document version as part of a hit.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forSearchRequest
-
_ENDPOINT
Endpoint "search
".
-
-
Method Details
-
of
-
source
Indicates which source fields are returned for matching documents. These fields are returned in the hits._source property of the search response.API name:
_source
-
aggregations
Defines the aggregations that are run as part of the search request.API name:
aggregations
-
allowNoIndices
Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targetingfoo*,bar*
returns an error if an index starts withfoo
but no index starts withbar
.API name:
allow_no_indices
-
allowPartialSearchResults
If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results.API name:
allow_partial_search_results
-
analyzeWildcard
If true, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified.API name:
analyze_wildcard
-
analyzer
Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified.API name:
analyzer
-
batchedReduceSize
The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.API name:
batched_reduce_size
-
ccsMinimizeRoundtrips
If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests.API name:
ccs_minimize_roundtrips
-
collapse
Collapses search results the values of the specified field.API name:
collapse
-
defaultOperator
The default operator for query string query: AND or OR. This parameter can only be used when theq
query string parameter is specified.API name:
default_operator
-
df
Field to use as default where no field prefix is given in the query string. This parameter can only be used when the q query string parameter is specified.API name:
df
-
docvalueFields
Array of wildcard (*
) patterns. The request returns doc values for field names matching these patterns in thehits.fields
property of the response.API name:
docvalue_fields
-
expandWildcards
Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such asopen,hidden
.API name:
expand_wildcards
-
explain
If true, returns detailed information about score computation as part of a hit.API name:
explain
-
ext
Configuration of search extensions defined by Elasticsearch plugins.API name:
ext
-
fields
Array of wildcard (*
) patterns. The request returns values for field names matching these patterns in thehits.fields
property of the response.API name:
fields
-
from
Starting document offset. Needs to be non-negative. By default, you cannot page through more than 10,000 hits using thefrom
andsize
parameters. To page through more hits, use thesearch_after
parameter.API name:
from
-
highlight
Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.API name:
highlight
-
ignoreThrottled
Iftrue
, concrete, expanded or aliased indices will be ignored when frozen.API name:
ignore_throttled
-
index
Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*
). To search all data streams and indices, omit this parameter or use*
or_all
.API name:
index
-
indicesBoost
Boosts the _score of documents from specified indices.API name:
indices_boost
-
knn
Defines the approximate kNN search to run.API name:
knn
-
lenient
Iftrue
, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can only be used when theq
query string parameter is specified.API name:
lenient
-
maxConcurrentShardRequests
Defines the number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.API name:
max_concurrent_shard_requests
-
minCompatibleShardNode
The minimum version of the node that can handle the request Any handling node with a lower version will fail the request.API name:
min_compatible_shard_node
-
minScore
Minimum_score
for matching documents. Documents with a lower_score
are not included in the search results.API name:
min_score
-
pit
Limits the search to a point in time (PIT). If you provide a PIT, you cannot specify an<index>
in the request path.API name:
pit
-
postFilter
Use thepost_filter
parameter to filter search results. The search hits are filtered after the aggregations are calculated. A post filter has no impact on the aggregation results.API name:
post_filter
-
preFilterShardSize
Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint). When unspecified, the pre-filter phase is executed if any of these conditions is met: the request targets more than 128 shards; the request targets one or more read-only index; the primary sort of the query targets an indexed field.API name:
pre_filter_shard_size
-
preference
Nodes and shards used for the search. By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are:_only_local
to run the search only on shards on the local node;_local
to, if possible, run the search on shards on the local node, or if not, select shards using the default method;_only_nodes:<node-id>,<node-id>
to run the search on only the specified nodes IDs, where, if suitable shards exist on more than one selected node, use shards on those nodes using the default method, or if none of the specified nodes are available, select shards from any available node using the default method;_prefer_nodes:<node-id>,<node-id>
to if possible, run the search on the specified nodes IDs, or if not, select shards using the default method;_shards:<shard>,<shard>
to run the search only on the specified shards;<custom-string>
(any string that does not start with_
) to route searches with the same<custom-string>
to the same shards in the same order.API name:
preference
-
profile
Set totrue
to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution.API name:
profile
-
q
Query in the Lucene query string syntax using query parameter search. Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing.API name:
q
-
query
Defines the search definition using the Query DSL.API name:
query
-
rank
Defines the Reciprocal Rank Fusion (RRF) to use.API name:
rank
-
requestCache
Iftrue
, the caching of search results is enabled for requests wheresize
is0
. Defaults to index level settings.API name:
request_cache
-
rescore
Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by thequery
andpost_filter
phases.API name:
rescore
-
routing
Custom value used to route operations to a specific shard.API name:
routing
-
runtimeMappings
Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name.API name:
runtime_mappings
-
scriptFields
Retrieve a script evaluation (based on different fields) for each hit.API name:
script_fields
-
scroll
Period to retain the search context for scrolling. See Scroll search results. By default, this value cannot exceed1d
(24 hours). You can change this limit using thesearch.max_keep_alive
cluster-level setting.API name:
scroll
-
searchAfter
Used to retrieve the next page of hits using a set of sort values from the previous page.API name:
search_after
-
searchType
How distributed term frequencies are calculated for relevance scoring.API name:
search_type
-
seqNoPrimaryTerm
Iftrue
, returns sequence number and primary term of the last modification of each hit.API name:
seq_no_primary_term
-
size
The number of hits to return. By default, you cannot page through more than 10,000 hits using thefrom
andsize
parameters. To page through more hits, use thesearch_after
parameter.API name:
size
-
slice
Can be used to split a scrolled search into multiple slices that can be consumed independently.API name:
slice
-
sort
A comma-separated list of <field>:<direction> pairs.API name:
sort
-
stats
Stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.API name:
stats
-
storedFields
List of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the_source
parameter defaults tofalse
. You can pass_source: true
to return both source fields and stored fields in the search response.API name:
stored_fields
-
suggest
Defines a suggester that provides similar looking terms based on a provided text.API name:
suggest
-
terminateAfter
Maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. If set to0
(default), the query does not terminate early.API name:
terminate_after
-
timeout
Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.API name:
timeout
-
trackScores
If true, calculate and return document scores, even if the scores are not used for sorting.API name:
track_scores
-
trackTotalHits
Number of hits matching the query to count accurately. Iftrue
, the exact number of hits is returned at the cost of some performance. Iffalse
, the response does not include the total number of hits matching the query.API name:
track_total_hits
-
version
If true, returns document version as part of a hit.API name:
version
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupSearchRequestDeserializer
-
createSearchEndpoint
public static <TDocument> Endpoint<SearchRequest,SearchResponse<TDocument>, createSearchEndpointErrorResponse> (JsonpDeserializer<TDocument> tDocumentDeserializer) Create an "search
" endpoint.
-