Package org.elasticsearch.client.indices
Class PutComponentTemplateRequest
java.lang.Object
org.elasticsearch.client.TimedRequest
org.elasticsearch.client.indices.PutComponentTemplateRequest
- All Implemented Interfaces:
Validatable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
public class PutComponentTemplateRequest extends TimedRequest implements org.elasticsearch.common.xcontent.ToXContentObject
A request to create an component template.
-
Nested Class Summary
-
Field Summary
Fields inherited from class org.elasticsearch.client.TimedRequest
DEFAULT_ACK_TIMEOUT, DEFAULT_MASTER_NODE_TIMEOUT
-
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.elasticsearch.cluster.metadata.ComponentTemplate componentTemplate)
The component template to create.boolean
create()
PutComponentTemplateRequest
create(boolean create)
Set totrue
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.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
Methods inherited from class org.elasticsearch.client.TimedRequest
masterNodeTimeout, setMasterTimeout, setTimeout, timeout
-
Constructor Details
-
PutComponentTemplateRequest
public PutComponentTemplateRequest()
-
-
Method Details
-
name
Sets the name of the component template. -
name
public java.lang.String name()The name of the component template. -
create
Set totrue
to force only creation, not an update of an component template. If it already exists, it will fail with anIllegalArgumentException
. -
create
public boolean create() -
componentTemplate
public PutComponentTemplateRequest componentTemplate(org.elasticsearch.cluster.metadata.ComponentTemplate componentTemplate)The component template to create. -
cause
The cause for this component template creation. -
cause
public java.lang.String cause() -
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
java.io.IOException
-