Package co.elastic.clients.elasticsearch.core

Class MsearchTemplateRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.MsearchTemplateRequest
All Implemented Interfaces:
JsonpSerializable, NdJsonpSerializable
public class MsearchTemplateRequest
extends RequestBase
implements NdJsonpSerializable, JsonpSerializable
Runs multiple templated searches with a single request.
See Also:
API specification

  • Field Details

  • Method Details

    • of

      public static MsearchTemplateRequest of​(java.util.function.Function<MsearchTemplateRequest.Builder,​ObjectBuilder<MsearchTemplateRequest>> fn)

    • _serializables

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

    • ccsMinimizeRoundtrips

      @Nullable public final java.lang.Boolean ccsMinimizeRoundtrips()
      Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution

      API name: ccs_minimize_roundtrips

    • index

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

      API name: index

    • maxConcurrentSearches

      @Nullable public final java.lang.Long maxConcurrentSearches()
      Controls the maximum number of concurrent searches the multi search api will execute

      API name: max_concurrent_searches

    • searchType

      @Nullable public final SearchType searchType()
      Search operation type

      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

    • searchTemplates

      public final java.util.List<RequestItem> searchTemplates()
      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

    • createMsearchTemplateEndpoint

      public static <TDocument> Endpoint<MsearchTemplateRequest,​MsearchTemplateResponse<TDocument>,​ErrorResponse> createMsearchTemplateEndpoint​(JsonpDeserializer<TDocument> tDocumentDeserializer)
      Create an "msearch_template" endpoint.