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:

ToJsonp

public final class PutIndexTemplateRequest
extends RequestBase
implements ToJsonp

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<PutIndexTemplateRequest>	DESERIALIZER	Json deserializer for PutIndexTemplateRequest
static Endpoint<PutIndexTemplateRequest,PutIndexTemplateResponse,OpenSearchError>	ENDPOINT	Endpoint "indices.put_index_template".

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PutIndexTemplateRequest(PutIndexTemplateRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	composedOf()	API name: composed_of
jakarta.json.JsonValue	dataStream()	API name: data_stream
java.util.List<java.lang.String>	indexPatterns()	API name: index_patterns
java.util.Map<java.lang.String,jakarta.json.JsonValue>	meta()	API name: _meta
java.lang.String	name()	Index or template name API name: name
java.lang.Number	priority()	API name: priority
protected static void	setupPutIndexTemplateRequestDeserializer(DelegatingDeserializer<PutIndexTemplateRequest.Builder> op)
IndexTemplateMapping	template()	API name: template
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
java.lang.Number	version()	API name: version

Methods inherited from class java.lang.Object

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

Field Details

DESERIALIZER

public static final JsonpDeserializer<PutIndexTemplateRequest> DESERIALIZER

Json deserializer for PutIndexTemplateRequest

ENDPOINT

public static final Endpoint<PutIndexTemplateRequest,PutIndexTemplateResponse,OpenSearchError> ENDPOINT

Endpoint "indices.put_index_template".

Constructor Details

PutIndexTemplateRequest

protected PutIndexTemplateRequest(PutIndexTemplateRequest.Builder builder)

Method Details

name

public java.lang.String name()

Index or template name API name: name

indexPatterns

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

API name: index_patterns

composedOf

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

API name: composed_of

template

@Nullable public IndexTemplateMapping template()

API name: template

dataStream

@Nullable public jakarta.json.JsonValue dataStream()

API name: data_stream

priority

@Nullable public java.lang.Number priority()

API name: priority

version

@Nullable public java.lang.Number version()

API name: version

meta

@Nullable public java.util.Map<java.lang.String,jakarta.json.JsonValue> meta()

API name: _meta

toJsonp

public void toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

toJsonp in interface ToJsonp

toJsonpInternal

protected void toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

setupPutIndexTemplateRequestDeserializer

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