Package org.opensearch.client.opensearch.indices

Class PutTemplateRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.indices.PutTemplateRequest
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<PutTemplateRequest.Builder,PutTemplateRequest>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public final class PutTemplateRequest extends RequestBase implements PlainJsonSerializable, ToCopyableBuilder<PutTemplateRequest.Builder,PutTemplateRequest>
Creates or updates an index template.

  • Field Details

  • Method Details

    • of

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

    • aliases

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

      API name: aliases

    • clusterManagerTimeout

      @Nullable public final Time clusterManagerTimeout()
      Operation timeout for connection to cluster-manager node.

      API name: cluster_manager_timeout

    • create

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

      API name: create

    • indexPatterns

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

      API name: index_patterns

    • mappings

      @Nullable public final TypeMapping mappings()
      API name: mappings

    • masterTimeout

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

      API name: master_timeout

    • name

      @Nonnull public final String name()
      Required - The name of the template

      API name: name

    • order

      @Nullable public final Integer order()

      Order in which OpenSearch 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

      @Nonnull public final Map<String,JsonData> settings()
      Configuration options for the index.

      API name: settings

    • version

      @Nullable public final Long version()
      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)

    • toBuilder

      @Nonnull public PutTemplateRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutTemplateRequest.Builder,PutTemplateRequest>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static PutTemplateRequest.Builder builder()

    • setupPutTemplateRequestDeserializer

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

    • applyQueryParameters

      protected void applyQueryParameters(@Nonnull Map<String,String> params)
      Overrides:
      applyQueryParameters in class RequestBase

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object