Package co.elastic.clients.elasticsearch.indices

Class GetIndexTemplateRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • flatSettings

      public final GetIndexTemplateRequest.Builder flatSettings​(@Nullable java.lang.Boolean value)
      If true, returns settings in flat format.

      API name: flat_settings

    • includeTypeName

      public final GetIndexTemplateRequest.Builder includeTypeName​(@Nullable java.lang.Boolean value)
      If true, a mapping type is expected in the body of mappings.

      API name: include_type_name

    • local

      public final GetIndexTemplateRequest.Builder local​(@Nullable java.lang.Boolean value)
      If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.

      API name: local

    • masterTimeout

      public final GetIndexTemplateRequest.Builder masterTimeout​(@Nullable Time value)
      Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • masterTimeout

      public final GetIndexTemplateRequest.Builder masterTimeout​(java.util.function.Function<Time.Builder,​ObjectBuilder<Time>> fn)
      Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • name

      public final GetIndexTemplateRequest.Builder name​(@Nullable java.lang.String value)
      Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.

      API name: name

    • build

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