Package org.opensearch.action.admin.indices.template.post

Class SimulateIndexTemplateRequest

java.lang.Object

org.opensearch.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest<Request>

org.opensearch.action.support.clustermanager.ClusterManagerNodeReadRequest<SimulateIndexTemplateRequest>

org.opensearch.action.admin.indices.template.post.SimulateIndexTemplateRequest

All Implemented Interfaces:

Writeable, TaskAwareRequest

public class SimulateIndexTemplateRequest
extends ClusterManagerNodeReadRequest<SimulateIndexTemplateRequest>

Transport Request for handling simulating an index template either by name (looking it up in the cluster state), or by a provided template configuration

Opensearch.internal:

Nested Class Summary

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

TransportRequest.Empty

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

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

Field Summary

Fields inherited from class org.opensearch.action.support.clustermanager.ClusterManagerNodeReadRequest

local

Fields inherited from class org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest

clusterManagerNodeTimeout, DEFAULT_CLUSTER_MANAGER_NODE_TIMEOUT, DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Constructor Summary

Constructors

Constructor	Description
SimulateIndexTemplateRequest(String indexName)
SimulateIndexTemplateRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getIndexName()
PutComposableIndexTemplateAction.Request	getIndexTemplateRequest()
int	hashCode()
SimulateIndexTemplateRequest	indexName(String indexName)
SimulateIndexTemplateRequest	indexTemplateRequest(PutComposableIndexTemplateAction.Request indexTemplateRequest)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.opensearch.action.support.clustermanager.ClusterManagerNodeReadRequest

local, local

Methods inherited from class org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest

clusterManagerNodeTimeout, clusterManagerNodeTimeout, clusterManagerNodeTimeout, masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.opensearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.opensearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.opensearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details

SimulateIndexTemplateRequest

public SimulateIndexTemplateRequest(String indexName)

SimulateIndexTemplateRequest

public SimulateIndexTemplateRequest(StreamInput in)
                             throws IOException

Throws:

IOException

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 ClusterManagerNodeReadRequest<SimulateIndexTemplateRequest>

Throws:

IOException

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

getIndexName

public String getIndexName()

getIndexTemplateRequest

@Nullable
public PutComposableIndexTemplateAction.Request getIndexTemplateRequest()

indexName

public SimulateIndexTemplateRequest indexName(String indexName)

indexTemplateRequest

public SimulateIndexTemplateRequest indexTemplateRequest(PutComposableIndexTemplateAction.Request indexTemplateRequest)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object