Class MultisearchBody
java.lang.Object
co.elastic.clients.elasticsearch.core.msearch.MultisearchBody
- All Implemented Interfaces:
JsonpSerializable
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<MultisearchBody>
Json deserializer forMultisearchBody
-
Method Summary
Modifier and TypeMethodDescriptionfinal Map<String,
Aggregation> API name:aggregations
final FieldCollapse
collapse()
API name:collapse
final List<FieldAndFormat>
Array of wildcard (*) patterns.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
API name:highlight
Boosts the _score of documents from specified indices.knn()
Defines the approximate kNN search to run.final Double
minScore()
Minimum _score for matching documents.static MultisearchBody
final PointInTimeReference
pit()
Limits the search to a point in time (PIT).final Query
API name:post_filter
final Boolean
profile()
API name:profile
final Query
query()
Defines the search definition using the Query DSL.rescore()
API name:rescore
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 List<FieldValue>
API name:search_after
final Boolean
If true, 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 List<SortOptions>
sort()
API name:sort
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()
API name:suggest
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.toString()
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.
-
Field Details
-
_DESERIALIZER
Json deserializer forMultisearchBody
-
-
Method Details
-
of
public static MultisearchBody of(Function<MultisearchBody.Builder, ObjectBuilder<MultisearchBody>> fn) -
aggregations
API name:aggregations
-
collapse
API name:collapse
-
query
Defines the search definition using the Query DSL.API name:
query
-
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
-
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 to false. You can pass _source: true to return both source fields and stored fields in the search response.API name:
stored_fields
-
docvalueFields
Array of wildcard (*) patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.API name:
docvalue_fields
-
knn
Defines the approximate kNN search to run.API name:
knn
-
from
Starting document offset. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.API name:
from
-
highlight
API name:highlight
-
indicesBoost
Boosts the _score of documents from specified indices.API name:
indices_boost
-
minScore
Minimum _score for matching documents. Documents with a lower _score are not included in the search results.API name:
min_score
-
postFilter
API name:post_filter
-
profile
API name:profile
-
rescore
API name:rescore
-
scriptFields
Retrieve a script evaluation (based on different fields) for each hit.API name:
script_fields
-
searchAfter
API name:search_after
-
size
The number of hits to return. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.API name:
size
-
sort
API name:sort
-
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
-
fields
Array of wildcard (*) patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.API name:
fields
-
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. Defaults to 0, which does not terminate query execution early.API name:
terminate_after
-
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
-
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. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits.API name:
track_total_hits
-
version
If true, returns document version as part of a hit.API name:
version
-
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
-
seqNoPrimaryTerm
If true, returns sequence number and primary term of the last modification of each hit. See Optimistic concurrency control.API name:
seq_no_primary_term
-
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
-
suggest
API name:suggest
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
toString
-
setupMultisearchBodyDeserializer
protected static void setupMultisearchBodyDeserializer(ObjectDeserializer<MultisearchBody.Builder> op)
-