Class MsearchRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch._core.MsearchRequest
- All Implemented Interfaces:
ElasticsearchCommonRequest
,JsonpSerializable
@JsonpDeserializable public final class MsearchRequest extends RequestBase implements JsonpSerializable
-
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 JsonpDeserializer<MsearchRequest>
_DESERIALIZER
-
Constructor Summary
Constructors Constructor Description MsearchRequest(MsearchRequest.Builder builder)
MsearchRequest(java.util.function.Function<MsearchRequest.Builder,MsearchRequest.Builder> fn)
-
Method Summary
Modifier and Type Method Description 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>,ElasticsearchError>createMsearchEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)
Create an "msearch
" endpoint.protected static JsonpDeserializer<MsearchRequest>
createMsearchRequestDeserializer()
java.util.List<ExpandWildcardOptions>
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.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.util.List<jakarta.json.JsonValue>
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.java.util.List<java.lang.String>
type()
A comma-separated list of document types to use as defaultjava.lang.Boolean
typedKeys()
Specifies whether aggregation and suggester names should be prefixed by their respective types in the response.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
-
-
Constructor Details
-
MsearchRequest
-
MsearchRequest
public MsearchRequest(java.util.function.Function<MsearchRequest.Builder,MsearchRequest.Builder> fn)
-
-
Method Details
-
index
@Nullable public java.util.List<java.lang.String> index()Comma-separated list of data streams, indices, and index aliases to search.API name:
index
-
type
@Nullable public java.util.List<java.lang.String> type()A comma-separated list of document types to use as defaultAPI name:
type
-
allowNoIndices
@Nullable public 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 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 java.lang.Boolean ignoreThrottled()If true, concrete, expanded or aliased indices are ignored when frozen.API name:
ignore_throttled
-
maxConcurrentSearches
@Nullable public java.lang.Long maxConcurrentSearches()Maximum number of concurrent searches the multi search API can execute.API name:
max_concurrent_searches
-
maxConcurrentShardRequests
@Nullable public 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 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
-
searchType
Indicates whether global term and document frequencies should be used when scoring returned documents.API name:
search_type
-
typedKeys
@Nullable public java.lang.Boolean typedKeys()Specifies whether aggregation and suggester names should be prefixed by their respective types in the response.API name:
typed_keys
-
searches
public java.util.List<jakarta.json.JsonValue> searches()Required - Request body.API name:
_value_body
-
serialize
Serialize this value to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
createMsearchRequestDeserializer
-
createMsearchEndpoint
public static <TDocument> Endpoint<MsearchRequest,MsearchResponse<TDocument>,ElasticsearchError> createMsearchEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)Create an "msearch
" endpoint.
-