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:

org.apache.lucene.util.Accountable, CompositeIndicesRequest, DocWriteRequest<DeleteRequest>, IndicesRequest, WriteRequest<DeleteRequest>, Writeable, org.elasticsearch.core.RefCounted, 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

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Fields inherited from interface org.elasticsearch.action.DocWriteRequest

REQUIRE_ALIAS

Constructor Summary

Constructors

Constructor	Description
DeleteRequest()
DeleteRequest(String index)	Constructs a new delete request against the specified index.
DeleteRequest(String index, String id)	Constructs a new delete request against the specified index and id.
DeleteRequest(String index, String type, String id)	Deprecated. Types are in the process of being removed.
DeleteRequest(StreamInput in)
DeleteRequest(ShardId shardId, StreamInput in)

Method Summary

Modifier and Type	Method	Description
DeleteRequest	defaultTypeIfNull(String defaultType)	Deprecated. Types are in the process of being removed.
String	id()	The id of the document to delete.
DeleteRequest	id(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.
boolean	isRequireAlias()	Should this request override specifically require the destination to be an alias?
DocWriteRequest.OpType	opType()	Get the requested document operation type of the request
long	ramBytesUsed()
String	routing()	Controls the shard routing of the delete request.
DeleteRequest	routing(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.
String	toString()
String	type()	Deprecated. Types are in the process of being removed.
DeleteRequest	type(String type)	Deprecated. Types are in the process of being removed.
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	writeThin(StreamOutput out)	Thin serialization that does not write ReplicationRequest.shardId and will only write ReplicationRequest.index if it is different from the index name in ReplicationRequest.shardId.
void	writeTo(StreamOutput out)	Write this into the 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, routedBasedOnClusterVersion, 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

decRef, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.util.Accountable

getChildResources

Methods inherited from interface org.elasticsearch.action.DocWriteRequest

index, index, indicesOptions

Methods inherited from interface org.elasticsearch.action.IndicesRequest

allowsRemoteIndices, includeDataStreams, indices

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

setParentTask

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

setRefreshPolicy

Constructor Details

DeleteRequest

public DeleteRequest(StreamInput in)
              throws IOException

Throws:

IOException

DeleteRequest

public DeleteRequest(@Nullable
 ShardId shardId,
 StreamInput in)
              throws IOException

Throws:

IOException

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

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

Deprecated.

Types are in the process of being removed. Use DeleteRequest(String, String) instead.

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(String index,
 String id)

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

Parameters:

index - The index to get the document from

id - The id of the document

Method Details

validate

public ActionRequestValidationException validate()

Specified by:

validate in interface WriteRequest<DeleteRequest>

Overrides:

validate in class ReplicationRequest<DeleteRequest>

type

@Deprecated
public String type()

Deprecated.

Types are in the process of being removed.

The type of the document to delete.

Specified by:

type in interface DocWriteRequest<DeleteRequest>

Returns:

the type

type

@Deprecated
public DeleteRequest type(String type)

Deprecated.

Types are in the process of being removed.

Sets the type of the document to delete.

Specified by:

type in interface DocWriteRequest<DeleteRequest>

Returns:

the Request

defaultTypeIfNull

@Deprecated
public DeleteRequest defaultTypeIfNull(String defaultType)

Deprecated.

Types are in the process of being removed.

Set the default type supplied to a bulk request if this individual request's type is null or empty

Specified by:

defaultTypeIfNull in interface DocWriteRequest<DeleteRequest>

Returns:

the Request

id

public String id()

The id of the document to delete.

Specified by:

id in interface DocWriteRequest<DeleteRequest>

Returns:

the id

id

public DeleteRequest id(String id)

Sets the id of the document to delete.

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

isRequireAlias

public boolean isRequireAlias()

Description copied from interface: DocWriteRequest

Should this request override specifically require the destination to be an alias?

Specified by:

isRequireAlias in interface DocWriteRequest<DeleteRequest>

Returns:

boolean flag, when true specifically requires an alias

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ReplicatedWriteRequest<DeleteRequest>

Throws:

IOException

writeThin

public void writeThin(StreamOutput out)
               throws IOException

Description copied from class: ReplicationRequest

Thin serialization that does not write ReplicationRequest.shardId and will only write ReplicationRequest.index if it is different from the index name in ReplicationRequest.shardId.

Overrides:

writeThin in class ReplicatedWriteRequest<DeleteRequest>

Throws:

IOException

toString

public String toString()

Specified by:

toString in class ReplicationRequest<DeleteRequest>

ramBytesUsed

public long ramBytesUsed()

Specified by:

ramBytesUsed in interface org.apache.lucene.util.Accountable