Package co.elastic.clients.elasticsearch.indices

Class PutTemplateRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • aliases

      public final PutTemplateRequest.Builder aliases​(java.util.Map<java.lang.String,​Alias> map)
      Aliases for the index.

      API name: aliases

      Adds all entries of map to aliases.

    • aliases

      public final PutTemplateRequest.Builder aliases​(java.lang.String key, Alias value)
      Aliases for the index.

      API name: aliases

      Adds an entry to aliases.

    • aliases

      public final PutTemplateRequest.Builder aliases​(java.lang.String key, java.util.function.Function<Alias.Builder,​ObjectBuilder<Alias>> fn)
      Aliases for the index.

      API name: aliases

      Adds an entry to aliases using a builder lambda.

    • create

      public final PutTemplateRequest.Builder create​(@Nullable java.lang.Boolean value)
      If true, this request cannot replace or update existing index templates.

      API name: create

    • flatSettings

      public final PutTemplateRequest.Builder flatSettings​(@Nullable java.lang.Boolean value)
      API name: flat_settings

    • includeTypeName

      public final PutTemplateRequest.Builder includeTypeName​(@Nullable java.lang.Boolean value)
      Whether a type should be returned in the body of the mappings.

      API name: include_type_name

    • indexPatterns

      public final PutTemplateRequest.Builder indexPatterns​(java.util.List<java.lang.String> list)
      Array of wildcard expressions used to match the names of indices during creation.

      API name: index_patterns

      Adds all elements of list to indexPatterns.

    • indexPatterns

      public final PutTemplateRequest.Builder indexPatterns​(java.lang.String value, java.lang.String... values)
      Array of wildcard expressions used to match the names of indices during creation.

      API name: index_patterns

      Adds one or more values to indexPatterns.

    • mappings

      public final PutTemplateRequest.Builder mappings​(@Nullable TypeMapping value)
      Mapping for fields in the index.

      API name: mappings

    • mappings

      public final PutTemplateRequest.Builder mappings​(java.util.function.Function<TypeMapping.Builder,​ObjectBuilder<TypeMapping>> fn)
      Mapping for fields in the index.

      API name: mappings

    • masterTimeout

      public final PutTemplateRequest.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 PutTemplateRequest.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 PutTemplateRequest.Builder name​(java.lang.String value)
      Required - The name of the template

      API name: name

    • order

      public final PutTemplateRequest.Builder order​(@Nullable java.lang.Integer value)
      Order in which Elasticsearch applies this template if index matches multiple templates.

      Templates with lower 'order' values are merged first. Templates with higher 'order' values are merged later, overriding templates with lower values.

      API name: order

    • settings

      public final PutTemplateRequest.Builder settings​(java.util.Map<java.lang.String,​JsonData> map)
      Configuration options for the index.

      API name: settings

      Adds all entries of map to settings.

    • settings

      public final PutTemplateRequest.Builder settings​(java.lang.String key, JsonData value)
      Configuration options for the index.

      API name: settings

      Adds an entry to settings.

    • timeout

      public final PutTemplateRequest.Builder timeout​(@Nullable Time value)
      API name: timeout

    • timeout

      public final PutTemplateRequest.Builder timeout​(java.util.function.Function<Time.Builder,​ObjectBuilder<Time>> fn)
      API name: timeout

    • version

      public final PutTemplateRequest.Builder version​(@Nullable java.lang.Long value)
      Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch.

      API name: version

    • build

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