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

Class DeleteIndexTemplateRequest

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

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

org.opensearch.action.admin.indices.template.delete.DeleteIndexTemplateRequest

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable, TaskAwareRequest

@PublicApi(since="1.0.0")
public class DeleteIndexTemplateRequest
extends ClusterManagerNodeRequest<DeleteIndexTemplateRequest>

A request to delete an index template.

Opensearch.api:

Nested Class Summary

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

TransportRequest.Empty

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

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
DeleteIndexTemplateRequest()
DeleteIndexTemplateRequest(String name)	Constructs a new delete index request for the specified name.
DeleteIndexTemplateRequest(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
String	name()	The index template name to delete.
DeleteIndexTemplateRequest	name(String name)	Set the index template name to delete.
ActionRequestValidationException	validate()
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

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.core.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details

DeleteIndexTemplateRequest

public DeleteIndexTemplateRequest(org.opensearch.core.common.io.stream.StreamInput in)
                           throws IOException

Throws:

IOException

DeleteIndexTemplateRequest

public DeleteIndexTemplateRequest()

DeleteIndexTemplateRequest

public DeleteIndexTemplateRequest(String name)

Constructs a new delete index request for the specified name.

Method Details

name

public DeleteIndexTemplateRequest name(String name)

Set the index template name to delete.

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

name

public String name()

The index template name to delete.

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Overrides:

writeTo in class ClusterManagerNodeRequest<DeleteIndexTemplateRequest>

Throws:

IOException