Class MsearchRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<MsearchRequest.Builder>
co.elastic.clients.elasticsearch.core.MsearchRequest.Builder
- All Implemented Interfaces:
WithJson<MsearchRequest.Builder>
,ObjectBuilder<MsearchRequest>
- Enclosing class:
- MsearchRequest
public static class MsearchRequest.Builder
extends RequestBase.AbstractBuilder<MsearchRequest.Builder>
implements ObjectBuilder<MsearchRequest>
Builder for
MsearchRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal MsearchRequest.Builder
allowNoIndices
(Boolean value) If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices.build()
Builds aMsearchRequest
.final MsearchRequest.Builder
ccsMinimizeRoundtrips
(Boolean value) If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.final MsearchRequest.Builder
expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Type of index that wildcard expressions can match.final MsearchRequest.Builder
expandWildcards
(List<ExpandWildcard> list) Type of index that wildcard expressions can match.final MsearchRequest.Builder
ignoreThrottled
(Boolean value) If true, concrete, expanded or aliased indices are ignored when frozen.final MsearchRequest.Builder
ignoreUnavailable
(Boolean value) If true, missing or closed indices are not included in the response.final MsearchRequest.Builder
Comma-separated list of data streams, indices, and index aliases to search.final MsearchRequest.Builder
Comma-separated list of data streams, indices, and index aliases to search.final MsearchRequest.Builder
maxConcurrentSearches
(Long value) Maximum number of concurrent searches the multi search API can execute.final MsearchRequest.Builder
maxConcurrentShardRequests
(Long value) Maximum number of concurrent shard requests that each sub-search request executes per node.final MsearchRequest.Builder
preFilterShardSize
(Long value) 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 MsearchRequest.Builder
Custom routing value used to route search operations to a specific shard.final MsearchRequest.Builder
searches
(RequestItem value, RequestItem... values) Required - Request body.final MsearchRequest.Builder
Required - Request body.final MsearchRequest.Builder
searches
(List<RequestItem> list) Required - Request body.final MsearchRequest.Builder
searchType
(SearchType value) Indicates whether global term and document frequencies should be used when scoring returned documents.protected MsearchRequest.Builder
self()
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
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
Adds all elements of
list
toexpandWildcards
. -
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
Adds one or more values to
expandWildcards
. -
ignoreThrottled
If true, concrete, expanded or aliased indices are ignored when frozen.API name:
ignore_throttled
-
index
Comma-separated list of data streams, indices, and index aliases to search.API name:
index
Adds all elements of
list
toindex
. -
index
Comma-separated list of data streams, indices, and index aliases to search.API name:
index
Adds one or more values to
index
. -
maxConcurrentSearches
Maximum number of concurrent searches the multi search API can execute.API name:
max_concurrent_searches
-
maxConcurrentShardRequests
Maximum number of concurrent shard requests that each sub-search request executes per node.API name:
max_concurrent_shard_requests
-
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
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.Adds all elements of
list
tosearches
. -
searches
Required - Request body.Adds one or more values to
searches
. -
searches
public final MsearchRequest.Builder searches(Function<RequestItem.Builder, ObjectBuilder<RequestItem>> fn) Required - Request body.Adds a value to
searches
using a builder lambda. -
self
- Specified by:
self
in classRequestBase.AbstractBuilder<MsearchRequest.Builder>
-
build
Builds aMsearchRequest
.- Specified by:
build
in interfaceObjectBuilder<MsearchRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-