Package co.elastic.clients.elasticsearch.core

Class MsearchRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.MsearchRequest
All Implemented Interfaces:
JsonpSerializable, NdJsonpSerializable
public class MsearchRequest extends RequestBase implements NdJsonpSerializable, JsonpSerializable
Run multiple searches.

The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. The structure is as follows: 

 header\n
 body\n
 header\n
 body\n

This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.

IMPORTANT: The final line of data must end with a newline character \n. Each newline character may be preceded by a carriage return \r. When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson.

See Also:

  • Field Details

  • Method Details

    • of

      public static MsearchRequest of(Function<MsearchRequest.Builder,ObjectBuilder<MsearchRequest>> fn)

    • _serializables

      public Iterator<?> _serializables()
      Specified by:
      _serializables in interface NdJsonpSerializable

    • allowNoIndices

      @Nullable public final 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 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 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 Boolean ignoreThrottled()
      If true, concrete, expanded or aliased indices are ignored when frozen.

      API name: ignore_throttled

    • ignoreUnavailable

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

      API name: ignore_unavailable

    • includeNamedQueriesScore

      @Nullable public final Boolean includeNamedQueriesScore()
      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 List<String> index()
      Comma-separated list of data streams, indices, and index aliases to search.

      API name: index

    • maxConcurrentSearches

      @Nullable public final Integer maxConcurrentSearches()
      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

      @Nullable public final Integer 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 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

    • projectRouting

      @Nullable public final String projectRouting()
      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

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

      API name: routing

    • searchType

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

      API name: search_type

    • searches

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

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator 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.