Package co.elastic.clients.elasticsearch.core

Class MsearchTemplateRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.core.MsearchTemplateRequest.Builder
All Implemented Interfaces:
ObjectBuilder<MsearchTemplateRequest>
Enclosing class:
MsearchTemplateRequest
public static class MsearchTemplateRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<MsearchTemplateRequest>
Builder for MsearchTemplateRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • ccsMinimizeRoundtrips

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

      API name: ccs_minimize_roundtrips

    • index

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

      API name: index

      Adds all elements of list to index.

    • index

      public final MsearchTemplateRequest.Builder index​(java.lang.String value, java.lang.String... values)
      A comma-separated list of index names to use as default

      API name: index

      Adds one or more values to index.

    • maxConcurrentSearches

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

      API name: max_concurrent_searches

    • searchType

      public final MsearchTemplateRequest.Builder searchType​(@Nullable SearchType value)
      Search operation type

      API name: search_type

    • type

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

      API name: type

      Adds all elements of list to type.

    • type

      public final MsearchTemplateRequest.Builder type​(java.lang.String value, java.lang.String... values)
      A comma-separated list of document types to use as default

      API name: type

      Adds one or more values to type.

    • searchTemplates

      public final MsearchTemplateRequest.Builder searchTemplates​(java.util.List<RequestItem> list)
      Required - Request body.

      Adds all elements of list to searchTemplates.

    • searchTemplates

      public final MsearchTemplateRequest.Builder searchTemplates​(RequestItem value, RequestItem... values)
      Required - Request body.

      Adds one or more values to searchTemplates.

    • searchTemplates

      public final MsearchTemplateRequest.Builder searchTemplates​(java.util.function.Function<RequestItem.Builder,​ObjectBuilder<RequestItem>> fn)
      Required - Request body.

      Adds a value to searchTemplates using a builder lambda.

    • build

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