org.elasticsearch.action.admin.indices.delete

Class DeleteIndexRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<Request>

org.elasticsearch.action.support.ChildTaskActionRequest<T>

org.elasticsearch.action.support.master.MasterNodeRequest<DeleteIndexRequest>

org.elasticsearch.action.admin.indices.delete.DeleteIndexRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class DeleteIndexRequest
extends MasterNodeRequest<DeleteIndexRequest>
implements IndicesRequest.Replaceable

A request to delete an index. Best created with Requests.deleteIndexRequest(String).

Nested Class Summary

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

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

Field Summary

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

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
DeleteIndexRequest()
DeleteIndexRequest(String... indices) Constructs a new delete index request for the specified indices.
DeleteIndexRequest(String index) Constructs a new delete index request for the specified index.

Method Summary

Methods

Modifier and Type	Method and Description
String[]	indices() The index to delete.
DeleteIndexRequest	indices(String... indices)
IndicesOptions	indicesOptions() Returns the indices options used to resolve indices.
DeleteIndexRequest	indicesOptions(IndicesOptions indicesOptions)
void	readFrom(StreamInput in)
TimeValue	timeout() Timeout to wait for the index deletion to be acknowledged by current cluster nodes.
DeleteIndexRequest	timeout(String timeout) Timeout to wait for the index deletion to be acknowledged by current cluster nodes.
DeleteIndexRequest	timeout(TimeValue timeout) Timeout to wait for the index deletion to be acknowledged by current cluster nodes.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

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

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.elasticsearch.action.support.ChildTaskActionRequest

createTask, createTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportRequest

getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteIndexRequest

public DeleteIndexRequest()

DeleteIndexRequest

public DeleteIndexRequest(String index)

Constructs a new delete index request for the specified index.

Parameters:

index - The index to delete. Use "_all" to delete all indices.

DeleteIndexRequest

public DeleteIndexRequest(String... indices)

Constructs a new delete index request for the specified indices.

Parameters:

indices - The indices to delete. Use "_all" to delete all indices.

Method Detail

indicesOptions

public IndicesOptions indicesOptions()

Description copied from interface: IndicesRequest

Returns 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:

indicesOptions in interface IndicesRequest

indicesOptions

public DeleteIndexRequest indicesOptions(IndicesOptions indicesOptions)

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<DeleteIndexRequest>

indices

public DeleteIndexRequest indices(String... indices)

Specified by:

indices in interface IndicesRequest.Replaceable

indices

public String[] indices()

The index to delete.

Specified by:

indices in interface IndicesRequest

timeout

public TimeValue timeout()

Timeout to wait for the index deletion to be acknowledged by current cluster nodes. Defaults to 10s.

timeout

public DeleteIndexRequest timeout(TimeValue timeout)

Timeout to wait for the index deletion to be acknowledged by current cluster nodes. Defaults to 10s.

timeout

public DeleteIndexRequest timeout(String timeout)

Timeout to wait for the index deletion to be acknowledged by current cluster nodes. Defaults to 10s.

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class MasterNodeRequest<DeleteIndexRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class MasterNodeRequest<DeleteIndexRequest>

Throws:

IOException