Package co.elastic.clients.elasticsearch.core

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 Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final MsearchRequest.Builder allowNoIndices(@Nullable Boolean value)
      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

      public final MsearchRequest.Builder ccsMinimizeRoundtrips(@Nullable Boolean value)
      If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.

      API name: ccs_minimize_roundtrips

    • expandWildcards

      public final MsearchRequest.Builder expandWildcards(List<ExpandWildcard> list)
      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 to expandWildcards.

    • expandWildcards

      public final MsearchRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)
      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

      public final MsearchRequest.Builder ignoreThrottled(@Nullable Boolean value)
      If true, concrete, expanded or aliased indices are ignored when frozen.

      API name: ignore_throttled

    • ignoreUnavailable

      public final MsearchRequest.Builder ignoreUnavailable(@Nullable Boolean value)
      If true, missing or closed indices are not included in the response.

      API name: ignore_unavailable

    • includeNamedQueriesScore

      public final MsearchRequest.Builder includeNamedQueriesScore(@Nullable Boolean value)
      Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) This functionality reruns each named query on every hit in a search response. Typically, this adds a small overhead to a request. However, using computationally expensive named queries on a large number of hits may add significant overhead.

      API name: include_named_queries_score

    • index

      public final MsearchRequest.Builder index(List<String> list)
      Comma-separated list of data streams, indices, and index aliases to search.

      API name: index

      Adds all elements of list to index.

    • index

      public final MsearchRequest.Builder index(String value, String... values)
      Comma-separated list of data streams, indices, and index aliases to search.

      API name: index

      Adds one or more values to index.

    • maxConcurrentSearches

      public final MsearchRequest.Builder maxConcurrentSearches(@Nullable Integer value)
      Maximum number of concurrent searches the multi search API can execute. Defaults to max(1, (# of data nodes * min(search thread pool size, 10))).

      API name: max_concurrent_searches

    • maxConcurrentShardRequests

      public final MsearchRequest.Builder maxConcurrentShardRequests(@Nullable Integer value)
      Maximum number of concurrent shard requests that each sub-search request executes per node.

      API name: max_concurrent_shard_requests

    • preFilterShardSize

      public final MsearchRequest.Builder preFilterShardSize(@Nullable 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. 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

    • projectRouting

      public final MsearchRequest.Builder projectRouting(@Nullable String value)
      Specifies a subset of projects to target for a search using project metadata tags in a subset Lucene syntax. Allowed Lucene queries: the _alias tag and a single value (possible wildcarded). Examples: _alias:my-project _alias:_origin _alias:pr Supported in serverless only.

      API name: project_routing

    • routing

      public final MsearchRequest.Builder routing(@Nullable String value)
      Custom routing value used to route search operations to a specific shard.

      API name: routing

    • searchType

      public final MsearchRequest.Builder searchType(@Nullable SearchType value)
      Indicates whether global term and document frequencies should be used when scoring returned documents.

      API name: search_type

    • searches

      public final MsearchRequest.Builder searches(List<RequestItem> list)
      Required - Request body.

      Adds all elements of list to searches.

    • searches

      public final MsearchRequest.Builder searches(RequestItem value, RequestItem... values)
      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

      protected MsearchRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<MsearchRequest.Builder>

    • build

      public MsearchRequest build()
      Builds a MsearchRequest.
      Specified by:
      build in interface ObjectBuilder<MsearchRequest>
      Throws:
      NullPointerException - if some of the required fields are null.