Package org.elasticsearch.action.delete

Class DeleteRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.support.replication.ReplicationRequest<R>

org.elasticsearch.action.support.replication.ReplicatedWriteRequest<DeleteRequest>

org.elasticsearch.action.delete.DeleteRequest

All Implemented Interfaces:

CompositeIndicesRequest, DocWriteRequest<DeleteRequest>, IndicesRequest, WriteRequest<DeleteRequest>, Streamable, Writeable, TaskAwareRequest

public class DeleteRequest
extends ReplicatedWriteRequest<DeleteRequest>
implements DocWriteRequest<DeleteRequest>, CompositeIndicesRequest

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.DocWriteRequest

DocWriteRequest.OpType

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>

Nested classes/interfaces inherited from interface org.elasticsearch.action.support.WriteRequest

WriteRequest.RefreshPolicy

Field Summary

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

DEFAULT_TIMEOUT, index, shardId, timeout, waitForActiveShards

Constructor Summary

Constructors

Constructor	Description
DeleteRequest()
DeleteRequest(java.lang.String index)	Constructs a new delete request against the specified index.
DeleteRequest(java.lang.String index, java.lang.String type, java.lang.String id)	Constructs a new delete request against the specified index with the type and id.

Method Summary

Modifier and Type	Method	Description
java.lang.String	id()	The id of the document to delete.
DeleteRequest	id(java.lang.String id)	Sets the id of the document to delete.
long	ifPrimaryTerm()	If set, only perform this delete request if the document was last modification was assigned this primary term.
long	ifSeqNo()	If set, only perform this delete request if the document was last modification was assigned this sequence number.
DocWriteRequest.OpType	opType()	Get the requested document operation type of the request
java.lang.String	parent()	Get the parent for this request
DeleteRequest	parent(java.lang.String parent)	Sets the parent id of this document.
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
java.lang.String	routing()	Controls the shard routing of the delete request.
DeleteRequest	routing(java.lang.String routing)	Controls the shard routing of the request.
DeleteRequest	setIfPrimaryTerm(long term)	only perform this delete request if the document was last modification was assigned the given primary term.
DeleteRequest	setIfSeqNo(long seqNo)	only perform this delete request if the document was last modification was assigned the given sequence number.
DeleteRequest	setShardId(ShardId shardId)	Override this method from ReplicationAction, this is where we are storing our state in the request object (which we really shouldn't do).
java.lang.String	toString()
java.lang.String	type()	The type of the document to delete.
DeleteRequest	type(java.lang.String type)	Sets the type of the document to delete.
ActionRequestValidationException	validate()
long	version()	Get the document version for this request
DeleteRequest	version(long version)	Sets the version, which will perform the operation only if a matching version exists and no changes happened on the doc since then.
VersionType	versionType()	Get the document version type for this request
DeleteRequest	versionType(VersionType versionType)	Sets the versioning type.
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

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

getRefreshPolicy, setRefreshPolicy

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

createTask, getDescription, index, index, indices, indicesOptions, onRetry, shardId, timeout, timeout, timeout, waitForActiveShards, waitForActiveShards, waitForActiveShards

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

Methods inherited from interface org.elasticsearch.action.DocWriteRequest

index, index, indicesOptions

Methods inherited from interface org.elasticsearch.action.IndicesRequest

indices

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

setParentTask

Methods inherited from interface org.elasticsearch.action.support.WriteRequest

setRefreshPolicy

Constructor Detail

DeleteRequest

public DeleteRequest()

DeleteRequest

public DeleteRequest(java.lang.String index)

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

DeleteRequest

public DeleteRequest(java.lang.String index,
                     java.lang.String type,
                     java.lang.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

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in interface WriteRequest<DeleteRequest>

Overrides:

validate in class ReplicationRequest<DeleteRequest>

type

public java.lang.String type()

The type of the document to delete.

Specified by:

type in interface DocWriteRequest<DeleteRequest>

Returns:

the type

type

public DeleteRequest type(java.lang.String type)

Sets the type of the document to delete.

Specified by:

type in interface DocWriteRequest<DeleteRequest>

Returns:

the Request

id

public java.lang.String id()

The id of the document to delete.

Specified by:

id in interface DocWriteRequest<DeleteRequest>

Returns:

the id

id

public DeleteRequest id(java.lang.String id)

Sets the id of the document to delete.

parent

public java.lang.String parent()

Description copied from interface: DocWriteRequest

Get the parent for this request

Specified by:

parent in interface DocWriteRequest<DeleteRequest>

Returns:

The parent for this request.

parent

public DeleteRequest parent(java.lang.String parent)

Sets the parent id of this document.

routing

public DeleteRequest routing(java.lang.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 DocWriteRequest<DeleteRequest>

Returns:

the Request

routing

public java.lang.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 DocWriteRequest<DeleteRequest>

Returns:

the Routing

version

public DeleteRequest version(long version)

Description copied from interface: DocWriteRequest

Sets the version, which will perform the operation only if a matching version exists and no changes happened on the doc since then.

Specified by:

version in interface DocWriteRequest<DeleteRequest>

version

public long version()

Description copied from interface: DocWriteRequest

Get the document version for this request

Specified by:

version in interface DocWriteRequest<DeleteRequest>

Returns:

the document version

versionType

public DeleteRequest versionType(VersionType versionType)

Description copied from interface: DocWriteRequest

Sets the versioning type. Defaults to VersionType.INTERNAL.

Specified by:

versionType in interface DocWriteRequest<DeleteRequest>

ifSeqNo

public long ifSeqNo()

If set, only perform this delete request if the document was last modification was assigned this sequence number. If the document last modification was assigned a different sequence number a VersionConflictEngineException will be thrown.

Specified by:

ifSeqNo in interface DocWriteRequest<DeleteRequest>

ifPrimaryTerm

public long ifPrimaryTerm()

If set, only perform this delete request if the document was last modification was assigned this primary term. If the document last modification was assigned a different term a VersionConflictEngineException will be thrown.

Specified by:

ifPrimaryTerm in interface DocWriteRequest<DeleteRequest>

setIfSeqNo

public DeleteRequest setIfSeqNo(long seqNo)

only perform this delete request if the document was last modification was assigned the given sequence number. Must be used in combination with setIfPrimaryTerm(long) If the document last modification was assigned a different sequence number a VersionConflictEngineException will be thrown.

Specified by:

setIfSeqNo in interface DocWriteRequest<DeleteRequest>

setIfPrimaryTerm

public DeleteRequest setIfPrimaryTerm(long term)

only perform this delete request if the document was last modification was assigned the given primary term. Must be used in combination with setIfSeqNo(long) If the document last modification was assigned a different primary term a VersionConflictEngineException will be thrown.

Specified by:

setIfPrimaryTerm in interface DocWriteRequest<DeleteRequest>

versionType

public VersionType versionType()

Description copied from interface: DocWriteRequest

Get the document version type for this request

Specified by:

versionType in interface DocWriteRequest<DeleteRequest>

Returns:

the document version type

opType

public DocWriteRequest.OpType opType()

Description copied from interface: DocWriteRequest

Get the requested document operation type of the request

Specified by:

opType in interface DocWriteRequest<DeleteRequest>

Returns:

the operation type DocWriteRequest.OpType

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 ReplicatedWriteRequest<DeleteRequest>

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 ReplicatedWriteRequest<DeleteRequest>

Throws:

java.io.IOException

toString

public java.lang.String toString()

Specified by:

toString in class ReplicationRequest<DeleteRequest>

setShardId

public DeleteRequest setShardId(ShardId shardId)

Override this method from ReplicationAction, this is where we are storing our state in the request object (which we really shouldn't do). Once the transport client goes away we can move away from making this available, but in the meantime this is dangerous to set or use because the DeleteRequest object will always be wrapped in a bulk request envelope, which is where this *should* be set.

Overrides:

setShardId in class ReplicationRequest<DeleteRequest>