Class 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
  • Field Details

  • 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 interface NdJsonpSerializable
    • 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

      public final java.util.List<ExpandWildcard> 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

    • ignoreUnavailable

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

      API name: ignore_unavailable

    • 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

    • searchType

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

      API name: search_type

    • type

      public final java.util.List<java.lang.String> type()
      A comma-separated list of document types to use as default

      API name: type

    • searches

      public final java.util.List<RequestItem> searches()
      Required - Request body.

      API name: _value_body

    • serialize

      public void serialize​( generator, JsonpMapper mapper)
      Serialize this value to JSON.
      Specified by:
      serialize in interface JsonpSerializable
    • createMsearchEndpoint

      public static <TDocument> Endpoint<MsearchRequest,​MsearchResponse<TDocument>,​ErrorResponse> createMsearchEndpoint​(JsonpDeserializer<TDocument> tDocumentDeserializer)
      Create an "msearch" endpoint.