Package org.elasticsearch.action.admin.indices.template.put

Class PutComponentTemplateAction.Request

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.support.master.MasterNodeRequest<PutComponentTemplateAction.Request>

org.elasticsearch.action.admin.indices.template.put.PutComponentTemplateAction.Request

All Implemented Interfaces:

Writeable, org.elasticsearch.core.RefCounted, TaskAwareRequest

Enclosing class:

PutComponentTemplateAction

public static class PutComponentTemplateAction.Request
extends MasterNodeRequest<PutComponentTemplateAction.Request>

A request for putting a single component template into the cluster state

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Constructor Summary

Constructors

Constructor	Description
Request(String name)	Constructs a new put component template request with the provided name.
Request(StreamInput in)

Method Summary

Modifier and Type	Method	Description
String	cause()
PutComponentTemplateAction.Request	cause(String cause)	The cause for this index template creation.
ComponentTemplate	componentTemplate()
PutComponentTemplateAction.Request	componentTemplate(ComponentTemplate template)	The component template that will be inserted into the cluster state
boolean	create()
PutComponentTemplateAction.Request	create(boolean create)	Set to true to force only creation, not an update of an index template.
String	name()	The name of the index template.
String	toString()
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details

Request

public Request(StreamInput in)
        throws IOException

Throws:

IOException

Request

public Request(String name)

Constructs a new put component template request with the provided name.

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class MasterNodeRequest<PutComponentTemplateAction.Request>

Throws:

IOException

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

name

public String name()

The name of the index template.

create

public PutComponentTemplateAction.Request create(boolean create)

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

create

public boolean create()

cause

public PutComponentTemplateAction.Request cause(@Nullable
 String cause)

The cause for this index template creation.

cause

@Nullable
public String cause()

componentTemplate

public PutComponentTemplateAction.Request componentTemplate(ComponentTemplate template)

The component template that will be inserted into the cluster state

componentTemplate

public ComponentTemplate componentTemplate()

toString

public String toString()

Overrides:

toString in class TransportRequest