Package co.elastic.clients.elasticsearch.indices

Class PutTemplateRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.PutTemplateRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class PutTemplateRequest extends RequestBase implements JsonpSerializable
Creates or updates an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices.
See Also:

  • Field Details

  • Method Details

    • of

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

    • aliases

      public final Map<String,Alias> aliases()
      Aliases for the index.

      API name: aliases

    • create

      @Nullable public final Boolean create()
      If true, this request cannot replace or update existing index templates.

      API name: create

    • flatSettings

      @Nullable public final Boolean flatSettings()
      If true, returns settings in flat format.

      API name: flat_settings

    • indexPatterns

      public final List<String> indexPatterns()
      Array of wildcard expressions used to match the names of indices during creation.

      API name: index_patterns

    • mappings

      @Nullable public final TypeMapping mappings()
      Mapping for fields in the index.

      API name: mappings

    • masterTimeout

      @Nullable public final Time masterTimeout()
      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 String name()
      Required - The name of the template

      API name: name

    • order

      @Nullable public final Integer order()
      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 Map<String,JsonData> settings()
      Configuration options for the index.

      API name: settings

    • timeout

      @Nullable public final Time timeout()
      Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      API name: timeout

    • version

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

      API name: version

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • setupPutTemplateRequestDeserializer

      protected static void setupPutTemplateRequestDeserializer(ObjectDeserializer<PutTemplateRequest.Builder> op)