Package org.opensearch.client.opensearch.indices

Class PutIndexTemplateRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.PutIndexTemplateRequest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<PutIndexTemplateRequest.Builder,PutIndexTemplateRequest>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class PutIndexTemplateRequest
extends RequestBase
implements PlainJsonSerializable, ToCopyableBuilder<PutIndexTemplateRequest.Builder,PutIndexTemplateRequest>

Creates or updates an index template.

Nested Class Summary

Nested Classes

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

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 final JsonpDeserializer<PutIndexTemplateRequest>	_DESERIALIZER	Json deserializer for PutIndexTemplateRequest
static final Endpoint<PutIndexTemplateRequest,PutIndexTemplateResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.put_index_template".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static PutIndexTemplateRequest.Builder	builder()
final String	cause()	User defined reason for creating/updating the index template.
final Time	clusterManagerTimeout()	Operation timeout for connection to cluster-manager node.
final List<String>	composedOf()	An ordered list of component template names.
final Boolean	create()	If true, this request cannot replace or update existing index templates.
final IndexTemplateDataStreamConfiguration	dataStream()	API name: data_stream
boolean	equals(Object o)
int	hashCode()
final List<String>	indexPatterns()	API name: index_patterns
final Time	masterTimeout()	Deprecated.
final Map<String,JsonData>	meta()	API name: _meta
final String	name()	Required - Index or template name
static PutIndexTemplateRequest	of(Function<PutIndexTemplateRequest.Builder,ObjectBuilder<PutIndexTemplateRequest>> fn)
final Integer	priority()	Priority to determine index template precedence when a new data stream or index is created.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupPutIndexTemplateRequestDeserializer(ObjectDeserializer<PutIndexTemplateRequest.Builder> op)
final IndexTemplateMapping	template()	API name: template
PutIndexTemplateRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Long	version()	API name: version

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<PutIndexTemplateRequest> _DESERIALIZER

Json deserializer for PutIndexTemplateRequest

_ENDPOINT

public static final Endpoint<PutIndexTemplateRequest,PutIndexTemplateResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.put_index_template".

Method Details

of

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

cause

@Nullable
public final String cause()

User defined reason for creating/updating the index template.

API name: cause

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

composedOf

@Nonnull
public final List<String> composedOf()

An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.

API name: composed_of

create

@Nullable
public final Boolean create()

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

API name: create

dataStream

@Nullable
public final IndexTemplateDataStreamConfiguration dataStream()

API name: data_stream

indexPatterns

@Nonnull
public final List<String> indexPatterns()

API name: index_patterns

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Operation timeout for connection to cluster-manager node.

API name: master_timeout

meta

@Nonnull
public final Map<String,JsonData> meta()

API name: _meta

name

@Nonnull
public final String name()

Required - Index or template name

API name: name

priority

@Nullable
public final Integer priority()

Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by OpenSearch.

API name: priority

template

@Nullable
public final IndexTemplateMapping template()

API name: template

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 PutIndexTemplateRequest.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<PutIndexTemplateRequest.Builder,PutIndexTemplateRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static PutIndexTemplateRequest.Builder builder()

setupPutIndexTemplateRequestDeserializer

protected static void setupPutIndexTemplateRequestDeserializer(ObjectDeserializer<PutIndexTemplateRequest.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