Package org.elasticsearch.action.admin.indices.delete

Class DeleteIndexRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

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

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

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

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, AckedRequest, Streamable, Writeable, TaskAwareRequest

public class DeleteIndexRequest
extends AcknowledgedRequest<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

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

DEFAULT_ACK_TIMEOUT, timeout

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

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
java.lang.String[]	indices()	The index to delete.
DeleteIndexRequest	indices(java.lang.String... indices)	Sets the indices that the action relates to.
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
DeleteIndexRequest	indicesOptions(IndicesOptions indicesOptions)
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

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

ackTimeout, timeout, timeout, timeout

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

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.elasticsearch.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.elasticsearch.cluster.ack.AckedRequest

masterNodeTimeout

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Detail

DeleteIndexRequest

public DeleteIndexRequest()

DeleteIndexRequest

public DeleteIndexRequest(java.lang.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(java.lang.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

indices

public DeleteIndexRequest indices(java.lang.String... indices)

Description copied from interface: IndicesRequest.Replaceable

Sets the indices that the action relates to.

Specified by:

indices in interface IndicesRequest.Replaceable

indices

public java.lang.String[] indices()

The index to delete.

Specified by:

indices in interface IndicesRequest

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class AcknowledgedRequest<DeleteIndexRequest>

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class AcknowledgedRequest<DeleteIndexRequest>

Throws:

java.io.IOException