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:

ToJsonp

public final class PutTemplateRequest
extends RequestBase
implements ToJsonp

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<PutTemplateRequest>	DESERIALIZER	Json deserializer for PutTemplateRequest
static Endpoint<PutTemplateRequest,PutTemplateResponse,OpenSearchError>	ENDPOINT	Endpoint "indices.put_template".

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PutTemplateRequest(PutTemplateRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,Alias>	aliases()	API name: aliases
java.lang.Boolean	create()	API name: create
java.lang.Boolean	flatSettings()	API name: flat_settings
java.lang.Boolean	includeTypeName()	API name: include_type_name
java.util.List<java.lang.String>	indexPatterns()	API name: index_patterns
TypeMapping	mappings()	API name: mappings
jakarta.json.JsonValue	masterTimeout()	API name: master_timeout
java.lang.String	name()	API name: name
java.lang.Number	order()	API name: order
java.util.Map<java.lang.String,jakarta.json.JsonValue>	settings()	API name: settings
protected static void	setupPutTemplateRequestDeserializer(DelegatingDeserializer<PutTemplateRequest.Builder> op)
jakarta.json.JsonValue	timeout()	API name: timeout
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<PutTemplateRequest> DESERIALIZER

Json deserializer for PutTemplateRequest

ENDPOINT

public static final Endpoint<PutTemplateRequest,PutTemplateResponse,OpenSearchError> ENDPOINT

Endpoint "indices.put_template".

Constructor Details

PutTemplateRequest

protected PutTemplateRequest(PutTemplateRequest.Builder builder)

Method Details

name

public java.lang.String name()

API name: name

create

@Nullable public java.lang.Boolean create()

API name: create

flatSettings

@Nullable public java.lang.Boolean flatSettings()

API name: flat_settings

includeTypeName

@Nullable public java.lang.Boolean includeTypeName()

API name: include_type_name

masterTimeout

@Nullable public jakarta.json.JsonValue masterTimeout()

API name: master_timeout

timeout

@Nullable public jakarta.json.JsonValue timeout()

API name: timeout

aliases

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

API name: aliases

indexPatterns

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

API name: index_patterns

mappings

@Nullable public TypeMapping mappings()

API name: mappings

order

@Nullable public java.lang.Number order()

API name: order

settings

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

API name: settings

version

@Nullable public java.lang.Number version()

API name: version

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)

setupPutTemplateRequestDeserializer

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