org.elasticsearch.action.delete

Class DeleteRequest

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.replication.ReplicationRequest<DeleteRequest>

org.elasticsearch.action.delete.DeleteRequest

All Implemented Interfaces:

DocumentRequest<DeleteRequest>, IndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class DeleteRequest
extends ReplicationRequest<DeleteRequest>
implements DocumentRequest<DeleteRequest>

A request to delete a document from an index based on its type and id. Best created using Requests.deleteRequest(String).

The operation requires the ReplicationRequest.index(), type(String) and id(String) to be set.

See Also:

DeleteResponse, Client.delete(DeleteRequest), Requests.deleteRequest(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.replication.ReplicationRequest

DEFAULT_TIMEOUT, index, shardId, timeout

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
DeleteRequest()
DeleteRequest(ActionRequest request) Creates a delete request caused by some other request, which is provided as an argument so that its headers and context can be copied to the new request
DeleteRequest(DeleteRequest request) Copy constructor that creates a new delete request that is a copy of the one provided as an argument.
DeleteRequest(DeleteRequest request, ActionRequest originalRequest) Copy constructor that creates a new delete request that is a copy of the one provided as an argument.
DeleteRequest(String index) Constructs a new delete request against the specified index.
DeleteRequest(String index, String type, String id) Constructs a new delete request against the specified index with the type and id.

Method Summary

Methods

Modifier and Type	Method and Description
String	id() The id of the document to delete.
DeleteRequest	id(String id) Sets the id of the document to delete.
DeleteRequest	parent(String parent) Sets the parent id of this document.
void	readFrom(StreamInput in)
boolean	refresh()
DeleteRequest	refresh(boolean refresh) Should a refresh be executed post this index operation causing the operation to be searchable.
String	routing() Controls the shard routing of the delete request.
DeleteRequest	routing(String routing) Controls the shard routing of the request.
String	toString()
String	type() The type of the document to delete.
DeleteRequest	type(String type) Sets the type of the document to delete.
ActionRequestValidationException	validate()
long	version()
DeleteRequest	version(long version) Sets the version, which will cause the delete operation to only be performed if a matching version exists and no changes happened on the doc since then.
VersionType	versionType()
DeleteRequest	versionType(VersionType versionType)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.support.replication.ReplicationRequest

canHaveDuplicates, consistencyLevel, consistencyLevel, createTask, getDescription, index, index, indices, indicesOptions, setShardId, shardId, timeout, timeout, timeout

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

createTask, setParentTask

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

Methods inherited from interface org.elasticsearch.action.DocumentRequest

index, indicesOptions

Methods inherited from interface org.elasticsearch.action.IndicesRequest

indices

Constructor Detail

DeleteRequest

public DeleteRequest()

DeleteRequest

public DeleteRequest(String index)

Constructs a new delete request against the specified index. The type(String) and id(String) must be set.

DeleteRequest

public DeleteRequest(String index,
             String type,
             String id)

Constructs a new delete request against the specified index with the type and id.

Parameters:

index - The index to get the document from

type - The type of the document

id - The id of the document

DeleteRequest

public DeleteRequest(DeleteRequest request)

Copy constructor that creates a new delete request that is a copy of the one provided as an argument.

DeleteRequest

public DeleteRequest(DeleteRequest request,
             ActionRequest originalRequest)

Copy constructor that creates a new delete request that is a copy of the one provided as an argument. The new request will inherit though headers and context from the original request that caused it.

DeleteRequest

public DeleteRequest(ActionRequest request)

Creates a delete request caused by some other request, which is provided as an argument so that its headers and context can be copied to the new request

Method Detail

validate

public ActionRequestValidationException validate()

Overrides:

validate in class ReplicationRequest<DeleteRequest>

type

public String type()

The type of the document to delete.

Specified by:

type in interface DocumentRequest<DeleteRequest>

Returns:

the type

type

public DeleteRequest type(String type)

Sets the type of the document to delete.

id

public String id()

The id of the document to delete.

Specified by:

id in interface DocumentRequest<DeleteRequest>

Returns:

the id

id

public DeleteRequest id(String id)

Sets the id of the document to delete.

parent

public DeleteRequest parent(String parent)

Sets the parent id of this document. Will simply set the routing to this value, as it is only used for routing with delete requests.

routing

public DeleteRequest routing(String routing)

Controls the shard routing of the request. Using this value to hash the shard and not the id.

Specified by:

routing in interface DocumentRequest<DeleteRequest>

Returns:

the Request

routing

public String routing()

Controls the shard routing of the delete request. Using this value to hash the shard and not the id.

Specified by:

routing in interface DocumentRequest<DeleteRequest>

Returns:

the Routing

refresh

public DeleteRequest refresh(boolean refresh)

Should a refresh be executed post this index operation causing the operation to be searchable. Note, heavy indexing should not set this to true. Defaults to false.

refresh

public boolean refresh()

version

public DeleteRequest version(long version)

Sets the version, which will cause the delete operation to only be performed if a matching version exists and no changes happened on the doc since then.

version

public long version()

versionType

public DeleteRequest versionType(VersionType versionType)

versionType

public VersionType versionType()

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ReplicationRequest<DeleteRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ReplicationRequest<DeleteRequest>

Throws:

IOException

toString

public String toString()

Overrides:

toString in class ReplicationRequest<DeleteRequest>