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:
ElasticsearchCommonRequest, JsonpSerializable
@JsonpDeserializable
public final class PutTemplateRequest
extends RequestBase
implements JsonpSerializable

  • Field Details

  • Constructor Details

  • Method Details

    • name

      public java.lang.String name()
      Required - The name of the template

      API name: name

    • create

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

      API name: create

    • flatSettings

      @Nullable public java.lang.Boolean flatSettings()
      API name: flat_settings

    • includeTypeName

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

      API name: include_type_name

    • masterTimeout

      @Nullable public java.lang.String 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

    • timeout

      @Nullable public java.lang.String timeout()
      API name: timeout

    • aliases

      @Nullable public java.util.Map<java.lang.String,​Alias> aliases()
      Aliases for the index.

      API name: aliases

    • indexPatterns

      @Nullable public java.util.List<java.lang.String> indexPatterns()
      Array of wildcard expressions used to match the names of indices during creation.

      API name: index_patterns

    • mappings

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

      API name: mappings

    • order

      @Nullable public java.lang.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

      @Nullable public java.util.Map<java.lang.String,​JsonData> settings()
      Configuration options for the index.

      API name: settings

    • version

      @Nullable public java.lang.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​(DelegatingDeserializer<PutTemplateRequest.Builder> op)