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

@JsonpDeserializable
public class PutIndexTemplateRequest
extends RequestBase
implements JsonpSerializable

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

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	composedOf()	API name: composed_of
DataStream	dataStream()	API name: data_stream
java.util.List<java.lang.String>	indexPatterns()	API name: index_patterns
java.util.Map<java.lang.String,JsonData>	meta()	API name: _meta
java.lang.String	name()	Required - Index or template name
static PutIndexTemplateRequest	of(java.util.function.Function<PutIndexTemplateRequest.Builder,ObjectBuilder<PutIndexTemplateRequest>> fn)
java.lang.Integer	priority()	API name: priority
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)
IndexTemplateMapping	template()	API name: template
java.lang.Long	version()	API name: version

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<PutIndexTemplateRequest> _DESERIALIZER

Json deserializer for PutIndexTemplateRequest

_ENDPOINT

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

Endpoint "indices.put_index_template".

Method Detail

of

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

meta

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

API name: _meta

composedOf

public final java.util.List<java.lang.String> composedOf()

API name: composed_of

dataStream

@Nullable
public final DataStream dataStream()

API name: data_stream

indexPatterns

public final java.util.List<java.lang.String> indexPatterns()

API name: index_patterns

name

public final java.lang.String name()

Required - Index or template name

API name: name

priority

@Nullable
public final java.lang.Integer priority()

API name: priority

template

@Nullable
public final IndexTemplateMapping template()

API name: template

version

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

setupPutIndexTemplateRequestDeserializer

protected static void setupPutIndexTemplateRequestDeserializer(ObjectDeserializer<PutIndexTemplateRequest.Builder> op)