Package org.opensearch.client.opensearch._global

Class MsearchRequest.Builder

java.lang.Object
org.opensearch.client.opensearch._global.MsearchRequest.Builder
All Implemented Interfaces:
ObjectBuilder<MsearchRequest>
Enclosing class:
MsearchRequest
public static class MsearchRequest.Builder
extends java.lang.Object
implements ObjectBuilder<MsearchRequest>
Builder for MsearchRequest.

  • Constructor Details

  • Method Details

    • index

      public MsearchRequest.Builder index​(@Nullable java.util.List<java.lang.String> value)
      Comma-separated list of data streams, indices, and index aliases to search. API name: index

    • index

      public MsearchRequest.Builder index​(java.lang.String... value)
      Comma-separated list of data streams, indices, and index aliases to search. API name: index

    • addIndex

      public MsearchRequest.Builder addIndex​(java.lang.String value)
      Add a value to index(List), creating the list if needed.

    • type

      public MsearchRequest.Builder type​(@Nullable java.util.List<java.lang.String> value)
      API name: type

    • type

      public MsearchRequest.Builder type​(java.lang.String... value)
      API name: type

    • addType

      public MsearchRequest.Builder addType​(java.lang.String value)
      Add a value to type(List), creating the list if needed.

    • allowNoIndices

      public MsearchRequest.Builder allowNoIndices​(@Nullable java.lang.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 MsearchRequest.Builder ccsMinimizeRoundtrips​(@Nullable java.lang.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 MsearchRequest.Builder expandWildcards​(@Nullable jakarta.json.JsonValue value)
      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

      public MsearchRequest.Builder ignoreThrottled​(@Nullable java.lang.Boolean value)
      If true, concrete, expanded or aliased indices are ignored when frozen. API name: ignore_throttled

    • ignoreUnavailable

      public MsearchRequest.Builder ignoreUnavailable​(@Nullable java.lang.Boolean value)
      If true, missing or closed indices are not included in the response. API name: ignore_unavailable

    • maxConcurrentSearches

      public MsearchRequest.Builder maxConcurrentSearches​(@Nullable java.lang.Number value)
      Maximum number of concurrent searches the multi search API can execute. API name: max_concurrent_searches

    • maxConcurrentShardRequests

      public MsearchRequest.Builder maxConcurrentShardRequests​(@Nullable java.lang.Number value)
      Maximum number of concurrent shard requests that each sub-search request executes per node. API name: max_concurrent_shard_requests

    • preFilterShardSize

      public MsearchRequest.Builder preFilterShardSize​(@Nullable java.lang.Number 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

    • searchType

      public MsearchRequest.Builder searchType​(@Nullable jakarta.json.JsonValue value)
      Indicates whether global term and document frequencies should be used when scoring returned documents. API name: search_type

    • restTotalHitsAsInt

      public MsearchRequest.Builder restTotalHitsAsInt​(@Nullable java.lang.Boolean value)
      If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. API name: rest_total_hits_as_int

    • typedKeys

      public MsearchRequest.Builder typedKeys​(@Nullable java.lang.Boolean value)
      Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. API name: typed_keys

    • value

      public MsearchRequest.Builder value​(java.util.List<jakarta.json.JsonValue> value)
      Request body. API name: value

    • value

      public MsearchRequest.Builder value​(jakarta.json.JsonValue... value)
      Request body. API name: value

    • addValue

      public MsearchRequest.Builder addValue​(jakarta.json.JsonValue value)
      Add a value to value(List), creating the list if needed.

    • build

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