- All Implemented Interfaces:
org.apache.lucene.util.Accountable
,CompositeIndicesRequest
,DocWriteRequest<DeleteRequest>
,IndicesRequest
,WriteRequest<DeleteRequest>
,Writeable
,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.
The operation requires the ReplicationRequest.index()
and id(String)
to
be set.
- See Also:
-
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
ConstructorDescriptionDeleteRequest
(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
(ShardId shardId, StreamInput in) -
Method Summary
Modifier and TypeMethodDescriptionid()
The id of the document to delete.Sets the id of the document to delete.long
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
Should this request override specifically require the destination to be an alias?opType()
Get the requested document operation type of the requestvoid
process
(IndexRouting indexRouting) Finalize the request before executing or routing it.long
int
route
(IndexRouting indexRouting) Pick the appropriate shard id to receive this request.routing()
Controls the shard routing of the delete request.Controls the shard routing of the request.setIfPrimaryTerm
(long term) only perform this delete request if the document was last modification was assigned the given primary term.setIfSeqNo
(long seqNo) only perform this delete request if the document was last modification was assigned the given sequence number.toString()
validate()
long
version()
Get the document version for this requestversion
(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.Get the document version type for this requestversionType
(VersionType versionType) Sets the versioning type.void
writeThin
(StreamOutput out) Thin serialization that does not writeReplicationRequest.shardId
and will only writeReplicationRequest.index
if it is different from the index name inReplicationRequest.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, getRequestId, setParentTask, setRequestId
Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, 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
getConcreteWriteIndex, index, index, indicesOptions
Methods inherited from interface org.elasticsearch.action.IndicesRequest
includeDataStreams, indices
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
setParentTask
Methods inherited from interface org.elasticsearch.action.support.WriteRequest
setRefreshPolicy
-
Constructor Details
-
DeleteRequest
- Throws:
IOException
-
DeleteRequest
- Throws:
IOException
-
DeleteRequest
public DeleteRequest() -
DeleteRequest
Constructs a new delete request against the specified index. Theid(String)
must be set. -
DeleteRequest
Constructs a new delete request against the specified index and id.- Parameters:
index
- The index to get the document fromid
- The id of the document
-
-
Method Details
-
validate
- Specified by:
validate
in interfaceWriteRequest<DeleteRequest>
- Overrides:
validate
in classReplicationRequest<DeleteRequest>
-
id
The id of the document to delete.- Specified by:
id
in interfaceDocWriteRequest<DeleteRequest>
- Returns:
- the id
-
id
Sets the id of the document to delete. -
routing
Controls the shard routing of the request. Using this value to hash the shard and not the id.- Specified by:
routing
in interfaceDocWriteRequest<DeleteRequest>
- Returns:
- the Request
-
routing
Controls the shard routing of the delete request. Using this value to hash the shard and not the id.- Specified by:
routing
in interfaceDocWriteRequest<DeleteRequest>
- Returns:
- the Routing
-
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 interfaceDocWriteRequest<DeleteRequest>
-
version
public long version()Description copied from interface:DocWriteRequest
Get the document version for this request- Specified by:
version
in interfaceDocWriteRequest<DeleteRequest>
- Returns:
- the document version
-
versionType
Description copied from interface:DocWriteRequest
Sets the versioning type. Defaults toVersionType.INTERNAL
.- Specified by:
versionType
in interfaceDocWriteRequest<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 aVersionConflictEngineException
will be thrown.- Specified by:
ifSeqNo
in interfaceDocWriteRequest<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 aVersionConflictEngineException
will be thrown.- Specified by:
ifPrimaryTerm
in interfaceDocWriteRequest<DeleteRequest>
-
setIfSeqNo
only perform this delete request if the document was last modification was assigned the given sequence number. Must be used in combination withsetIfPrimaryTerm(long)
If the document last modification was assigned a different sequence number aVersionConflictEngineException
will be thrown.- Specified by:
setIfSeqNo
in interfaceDocWriteRequest<DeleteRequest>
-
setIfPrimaryTerm
only perform this delete request if the document was last modification was assigned the given primary term. Must be used in combination withsetIfSeqNo(long)
If the document last modification was assigned a different primary term aVersionConflictEngineException
will be thrown.- Specified by:
setIfPrimaryTerm
in interfaceDocWriteRequest<DeleteRequest>
-
versionType
Description copied from interface:DocWriteRequest
Get the document version type for this request- Specified by:
versionType
in interfaceDocWriteRequest<DeleteRequest>
- Returns:
- the document version type
-
opType
Description copied from interface:DocWriteRequest
Get the requested document operation type of the request- Specified by:
opType
in interfaceDocWriteRequest<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 interfaceDocWriteRequest<DeleteRequest>
- Returns:
- boolean flag, when true specifically requires an alias
-
process
Description copied from interface:DocWriteRequest
Finalize the request before executing or routing it.- Specified by:
process
in interfaceDocWriteRequest<DeleteRequest>
-
route
Description copied from interface:DocWriteRequest
Pick the appropriate shard id to receive this request.- Specified by:
route
in interfaceDocWriteRequest<DeleteRequest>
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classReplicatedWriteRequest<DeleteRequest>
- Throws:
IOException
-
writeThin
Description copied from class:ReplicationRequest
Thin serialization that does not writeReplicationRequest.shardId
and will only writeReplicationRequest.index
if it is different from the index name inReplicationRequest.shardId
.- Overrides:
writeThin
in classReplicatedWriteRequest<DeleteRequest>
- Throws:
IOException
-
toString
- Specified by:
toString
in classReplicationRequest<DeleteRequest>
-
ramBytesUsed
public long ramBytesUsed()- Specified by:
ramBytesUsed
in interfaceorg.apache.lucene.util.Accountable
-