Package org.opensearch.client.opensearch.cluster

Class PutComponentTemplateRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cluster.PutComponentTemplateRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutComponentTemplateRequest
extends RequestBase
implements JsonpSerializable

Creates or updates a component template

Nested Class Summary

Nested Classes

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

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<PutComponentTemplateRequest>	_DESERIALIZER	Json deserializer for PutComponentTemplateRequest
static Endpoint<PutComponentTemplateRequest,PutComponentTemplateResponse,ErrorResponse>	_ENDPOINT	Endpoint "cluster.put_component_template".

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,AliasDefinition>	aliases()	API name: aliases
Time	clusterManagerTimeout()	Specify timeout for connection to cluster-manager
java.lang.Boolean	create()	Whether the index template should only be added if new or can also replace an existing one
TypeMapping	mappings()	API name: mappings
Time	masterTimeout()	Deprecated.
java.util.Map<java.lang.String,JsonData>	meta()	API name: _meta
java.lang.String	name()	Required - The name of the template
static PutComponentTemplateRequest	of(java.util.function.Function<PutComponentTemplateRequest.Builder,ObjectBuilder<PutComponentTemplateRequest>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
IndexSettings	settings()	API name: settings
protected static void	setupPutComponentTemplateRequestDeserializer(ObjectDeserializer<PutComponentTemplateRequest.Builder> op)
IndexState	template()	Required - 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<PutComponentTemplateRequest> _DESERIALIZER

Json deserializer for PutComponentTemplateRequest

_ENDPOINT

public static final Endpoint<PutComponentTemplateRequest,PutComponentTemplateResponse,ErrorResponse> _ENDPOINT

Endpoint "cluster.put_component_template".

Method Detail

of

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

meta

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

API name: _meta

aliases

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

API name: aliases

create

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

Whether the index template should only be added if new or can also replace an existing one

API name: create

mappings

@Nullable
public final TypeMapping mappings()

API name: mappings

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Specify timeout for connection to master

API name: master_timeout

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

name

public final java.lang.String name()

Required - The name of the template

API name: name

settings

@Nullable
public final IndexSettings settings()

API name: settings

template

public final IndexState template()

Required - 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)

setupPutComponentTemplateRequestDeserializer

protected static void setupPutComponentTemplateRequestDeserializer(ObjectDeserializer<PutComponentTemplateRequest.Builder> op)