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

@JsonpDeserializable
public class PutTemplateRequest
extends RequestBase
implements JsonpSerializable

Creates or updates an index template.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PutTemplateRequest.Builder	Builder for PutTemplateRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<PutTemplateRequest>	_DESERIALIZER	Json deserializer for PutTemplateRequest
static Endpoint<PutTemplateRequest,PutTemplateResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.put_template".

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,Alias>	aliases()	Aliases for the index.
Time	clusterManagerTimeout()	Period to wait for a connection to the cluster-manager node.
java.lang.Boolean	create()	If true, this request cannot replace or update existing index templates.
java.lang.Boolean	flatSettings()	API name: flat_settings
java.util.List<java.lang.String>	indexPatterns()	Array of wildcard expressions used to match the names of indices during creation.
TypeMapping	mappings()	Mapping for fields in the index.
Time	masterTimeout()	Deprecated.
java.lang.String	name()	Required - The name of the template
static PutTemplateRequest	of(java.util.function.Function<PutTemplateRequest.Builder,ObjectBuilder<PutTemplateRequest>> fn)
java.lang.Integer	order()	Order in which Elasticsearch applies this template if index matches multiple templates.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
java.util.Map<java.lang.String,JsonData>	settings()	Configuration options for the index.
protected static void	setupPutTemplateRequestDeserializer(ObjectDeserializer<PutTemplateRequest.Builder> op)
Time	timeout()	API name: timeout
java.lang.Long	version()	Version number used to manage index templates externally.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<PutTemplateRequest> _DESERIALIZER

Json deserializer for PutTemplateRequest

_ENDPOINT

public static final Endpoint<PutTemplateRequest,PutTemplateResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.put_template".

Method Detail

of

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

aliases

public final java.util.Map<java.lang.String,Alias> aliases()

Aliases for the index.

API name: aliases

create

@Nullable
public final java.lang.Boolean create()

If true, this request cannot replace or update existing index templates.

API name: create

flatSettings

@Nullable
public final java.lang.Boolean flatSettings()

API name: flat_settings

indexPatterns

public final 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 final TypeMapping mappings()

Mapping for fields in the index.

API name: mappings

masterTimeout

@Deprecated
@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

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

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: cluster_manager_timeout

name

public final java.lang.String name()

Required - The name of the template

API name: name

order

@Nullable
public final 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

public final java.util.Map<java.lang.String,JsonData> settings()

Configuration options for the index.

API name: settings

timeout

@Nullable
public final Time timeout()

API name: timeout

version

@Nullable
public final 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(ObjectDeserializer<PutTemplateRequest.Builder> op)