Class MsearchRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.MsearchRequest
- All Implemented Interfaces:
JsonpSerializable
,NdJsonpSerializable
public class MsearchRequest extends RequestBase implements NdJsonpSerializable, JsonpSerializable
Allows to execute several search operations in one request.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MsearchRequest.Builder
Builder forMsearchRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static SimpleEndpoint<MsearchRequest,?>
_ENDPOINT
Endpoint "msearch
". -
Method Summary
Modifier and Type Method Description java.util.Iterator<?>
_serializables()
java.lang.Boolean
allowNoIndices()
If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices.java.lang.Boolean
ccsMinimizeRoundtrips()
If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.static <TDocument>
Endpoint<MsearchRequest,MsearchResponse<TDocument>,ErrorResponse>createMsearchEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)
Create an "msearch
" endpoint.java.util.List<ExpandWildcard>
expandWildcards()
Type of index that wildcard expressions can match.java.lang.Boolean
ignoreThrottled()
If true, concrete, expanded or aliased indices are ignored when frozen.java.lang.Boolean
ignoreUnavailable()
If true, missing or closed indices are not included in the response.java.util.List<java.lang.String>
index()
Comma-separated list of data streams, indices, and index aliases to search.java.lang.Long
maxConcurrentSearches()
Maximum number of concurrent searches the multi search API can execute.java.lang.Long
maxConcurrentShardRequests()
Maximum number of concurrent shard requests that each sub-search request executes per node.static MsearchRequest
of(java.util.function.Function<MsearchRequest.Builder,ObjectBuilder<MsearchRequest>> fn)
java.lang.Long
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.java.lang.String
routing()
Custom routing value used to route search operations to a specific shard.java.util.List<RequestItem>
searches()
Required - Request body.SearchType
searchType()
Indicates whether global term and document frequencies should be used when scoring returned documents.void
serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
Serialize this value to JSON.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_ENDPOINT
Endpoint "msearch
".
-
-
Method Details
-
of
public static MsearchRequest of(java.util.function.Function<MsearchRequest.Builder,ObjectBuilder<MsearchRequest>> fn) -
_serializables
public java.util.Iterator<?> _serializables()- Specified by:
_serializables
in interfaceNdJsonpSerializable
-
allowNoIndices
@Nullable public final java.lang.Boolean allowNoIndices()If false, 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 targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.API name:
allow_no_indices
-
ccsMinimizeRoundtrips
@Nullable public final java.lang.Boolean ccsMinimizeRoundtrips()If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.API name:
ccs_minimize_roundtrips
-
expandWildcards
Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.API name:
expand_wildcards
-
ignoreThrottled
@Nullable public final java.lang.Boolean ignoreThrottled()If true, concrete, expanded or aliased indices are ignored when frozen.API name:
ignore_throttled
-
index
public final java.util.List<java.lang.String> index()Comma-separated list of data streams, indices, and index aliases to search.API name:
index
-
maxConcurrentSearches
@Nullable public final java.lang.Long maxConcurrentSearches()Maximum number of concurrent searches the multi search API can execute.API name:
max_concurrent_searches
-
maxConcurrentShardRequests
@Nullable public final java.lang.Long maxConcurrentShardRequests()Maximum number of concurrent shard requests that each sub-search request executes per node.API name:
max_concurrent_shard_requests
-
preFilterShardSize
@Nullable public final java.lang.Long 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 i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint.API name:
pre_filter_shard_size
-
routing
@Nullable public final java.lang.String routing()Custom routing value used to route search operations to a specific shard.API name:
routing
-
searchType
Indicates whether global term and document frequencies should be used when scoring returned documents.API name:
search_type
-
searches
Required - Request body. -
serialize
Serialize this value to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
createMsearchEndpoint
public static <TDocument> Endpoint<MsearchRequest,MsearchResponse<TDocument>,ErrorResponse> createMsearchEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)Create an "msearch
" endpoint.
-