Package org.opensearch.client.indices

Class PutComponentTemplateRequest

java.lang.Object

org.opensearch.client.TimedRequest

org.opensearch.client.indices.PutComponentTemplateRequest

All Implemented Interfaces:

Validatable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentObject

public class PutComponentTemplateRequest
extends TimedRequest
implements org.opensearch.common.xcontent.ToXContentObject

A request to create an component template.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

Field Summary

Fields inherited from class org.opensearch.client.TimedRequest

DEFAULT_ACK_TIMEOUT, DEFAULT_MASTER_NODE_TIMEOUT

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Fields inherited from interface org.opensearch.client.Validatable

EMPTY

Constructor Summary

Constructors

Constructor	Description
PutComponentTemplateRequest()

Method Summary

Modifier and Type	Method	Description
java.lang.String	cause()
PutComponentTemplateRequest	cause(java.lang.String cause)	The cause for this component template creation.
PutComponentTemplateRequest	componentTemplate(org.opensearch.cluster.metadata.ComponentTemplate componentTemplate)	The component template to create.
boolean	create()
PutComponentTemplateRequest	create(boolean create)	Set to true to force only creation, not an update of an component template.
java.lang.String	name()	The name of the component template.
PutComponentTemplateRequest	name(java.lang.String name)	Sets the name of the component template.
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)

Methods inherited from class org.opensearch.client.TimedRequest

masterNodeTimeout, setMasterTimeout, setTimeout, timeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.common.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.opensearch.client.Validatable

validate

Constructor Detail

PutComponentTemplateRequest

public PutComponentTemplateRequest()

Method Detail

name

public PutComponentTemplateRequest name(java.lang.String name)

Sets the name of the component template.

name

public java.lang.String name()

The name of the component template.

create

public PutComponentTemplateRequest create(boolean create)

Set to true to force only creation, not an update of an component template. If it already exists, it will fail with an IllegalArgumentException.

create

public boolean create()

componentTemplate

public PutComponentTemplateRequest componentTemplate(org.opensearch.cluster.metadata.ComponentTemplate componentTemplate)

The component template to create.

cause

public PutComponentTemplateRequest cause(java.lang.String cause)

The cause for this component template creation.

cause

public java.lang.String cause()

toXContent

public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder,
                                                                 org.opensearch.common.xcontent.ToXContent.Params params)
                                                          throws java.io.IOException

Specified by:

toXContent in interface org.opensearch.common.xcontent.ToXContent

Throws:

java.io.IOException