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

Class DeleteDanglingIndexRequest

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

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

org.opensearch.action.support.master.MasterNodeRequest<DeleteDanglingIndexRequest>

org.opensearch.action.support.master.AcknowledgedRequest<DeleteDanglingIndexRequest>

org.opensearch.action.admin.indices.dangling.delete.DeleteDanglingIndexRequest

All Implemented Interfaces:

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

@PublicApi(since="1.0.0")
public class DeleteDanglingIndexRequest
extends AcknowledgedRequest<DeleteDanglingIndexRequest>

Represents a request to delete a particular dangling index, specified by its UUID. The acceptDataLoss flag must also be explicitly set to true, or later validation will fail.

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.master.AcknowledgedRequest

DEFAULT_ACK_TIMEOUT, DEFAULT_TASK_EXECUTION_TIMEOUT, timeout

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
DeleteDanglingIndexRequest(String indexUUID, boolean acceptDataLoss)
DeleteDanglingIndexRequest(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
String	getIndexUUID()
boolean	isAcceptDataLoss()
String	toString()
ActionRequestValidationException	validate()
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.action.support.master.AcknowledgedRequest

ackTimeout, timeout, timeout, timeout

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, wait, wait, wait

Methods inherited from interface org.opensearch.cluster.ack.AckedRequest

clusterManagerNodeTimeout, masterNodeTimeout

Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details

DeleteDanglingIndexRequest

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

Throws:

IOException

DeleteDanglingIndexRequest

public DeleteDanglingIndexRequest(String indexUUID,
 boolean acceptDataLoss)

Method Details

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

getIndexUUID

public String getIndexUUID()

isAcceptDataLoss

public boolean isAcceptDataLoss()

toString

public String toString()

Overrides:

toString in class Object

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 AcknowledgedRequest<DeleteDanglingIndexRequest>

Throws:

IOException