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
@Deprecated @JsonpDeserializable public class PutTemplateRequest extends RequestBase implements JsonpSerializable
Deprecated.
7.8.0
Create or update a legacy index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. Elasticsearch applies templates to new indices based on an index pattern that matches the index name.

IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.

Composable templates always take precedence over legacy templates. If no composable template matches a new index, matching legacy templates are applied according to their order.

Index templates are only applied during index creation. Changes to index templates do not affect existing indices. Settings and mappings specified in create index API requests override any settings or mappings specified in an index template.

You can use C-style /* *\/ block comments in index templates. You can include comments anywhere in the request body, except before the opening curly bracket.

Indices matching multiple templates

Multiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index. The order of the merging can be controlled using the order parameter, with lower order being applied first, and higher orders overriding them. NOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order.

See Also:

  • Field Details

  • Method Details

    • of

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

    • aliases

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

      API name: aliases

    • cause

      @Nullable public final String cause()
      Deprecated.
      User defined reason for creating/updating the index template

      API name: cause

    • create

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

      API name: create

    • indexPatterns

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

      API name: index_patterns

    • mappings

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

      API name: mappings

    • masterTimeout

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

      API name: name

    • order

      @Nullable public final Integer order()
      Deprecated.
      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

      @Nullable public final IndexSettings settings()
      Deprecated.
      Configuration options for the index.

      API name: settings

    • version

      @Nullable public final Long version()
      Deprecated.
      Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch. To unset a version, replace the template without specifying one.

      API name: version

    • serialize

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

    • serializeInternal

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

    • setupPutTemplateRequestDeserializer

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