Module org.elasticsearch.server
Class TransportPutComposableIndexTemplateAction.Request
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.AbstractTransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.LegacyActionRequest
org.elasticsearch.action.support.master.MasterNodeRequest<TransportPutComposableIndexTemplateAction.Request>
org.elasticsearch.action.admin.indices.template.put.TransportPutComposableIndexTemplateAction.Request
- All Implemented Interfaces:
IndicesRequest,Writeable,RefCounted,TaskAwareRequest,TransportRequest
- Enclosing class:
TransportPutComposableIndexTemplateAction
public static class TransportPutComposableIndexTemplateAction.Request
extends MasterNodeRequest<TransportPutComposableIndexTemplateAction.Request>
implements IndicesRequest
A request for putting a single index template into the cluster state
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
IndicesRequest.RemoteClusterShardRequest, IndicesRequest.Replaceable, IndicesRequest.SingleIndexNoWildcardsNested 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
INFINITE_MASTER_NODE_TIMEOUT, TRAPPY_IMPLICIT_DEFAULT_MASTER_NODE_TIMEOUTFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new put index template request with the provided name.Request(StreamInput in) -
Method Summary
Modifier and TypeMethodDescriptioncause()The cause for this index template creation.booleancreate()create(boolean create) Set totrueto force only creation, not an update of an index template.booleaninthashCode()indexTemplate(ComposableIndexTemplate template) The index template that will be inserted into the cluster stateString[]indices()Returns the array of indices that the action relates toReturns the indices options used to resolve indices.name()The name of the index template.toString()validate()validateIndexTemplate(ActionRequestValidationException validationException) voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
masterNodeTimeout, masterNodeTimeout, masterTermMethods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResultMethods inherited from class org.elasticsearch.transport.AbstractTransportRequest
getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestIdMethods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, tryIncRefMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.action.IndicesRequest
includeDataStreamsMethods inherited from interface org.elasticsearch.core.RefCounted
decRef, hasReferences, incRef, mustIncRef, tryIncRefMethods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, createTask, getDescription, setParentTask
-
Constructor Details
-
Request
- Throws:
IOException
-
Request
Constructs a new put index template request with the provided name.
-
-
Method Details
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Overrides:
writeToin classMasterNodeRequest<TransportPutComposableIndexTemplateAction.Request>- Throws:
IOException
-
validate
- Specified by:
validatein classActionRequest
-
validateIndexTemplate
public ActionRequestValidationException validateIndexTemplate(@Nullable ActionRequestValidationException validationException) -
name
The name of the index template. -
create
Set totrueto force only creation, not an update of an index template. If it already exists, it will fail with anIllegalArgumentException. -
create
public boolean create() -
cause
The cause for this index template creation. -
cause
-
indexTemplate
public TransportPutComposableIndexTemplateAction.Request indexTemplate(ComposableIndexTemplate template) The index template that will be inserted into the cluster state -
indexTemplate
-
toString
- Overrides:
toStringin classAbstractTransportRequest
-
indices
Description copied from interface:IndicesRequestReturns the array of indices that the action relates to- Specified by:
indicesin interfaceIndicesRequest
-
indicesOptions
Description copied from interface:IndicesRequestReturns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.- Specified by:
indicesOptionsin interfaceIndicesRequest
-
hashCode
public int hashCode() -
equals
-