Package org.elasticsearch.action.delete
Class DeleteRequest
- java.lang.Object
-
- All Implemented Interfaces:
CompositeIndicesRequest
,DocWriteRequest<DeleteRequest>
,IndicesRequest
,WriteRequest<DeleteRequest>
,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 usingRequests.deleteRequest(String)
.The operation requires the
ReplicationRequest.index()
,type(String)
andid(String)
to be set.
-
-
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 id)
Constructs a new delete request against the specified index and id.DeleteRequest(java.lang.String index, java.lang.String type, java.lang.String id)
Deprecated.Types are in the process of being removed.DeleteRequest(StreamInput in)
-
Method Summary
Modifier and Type Method Description DeleteRequest
defaultTypeIfNull(java.lang.String defaultType)
Deprecated.Types are in the process of being removed.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 requestjava.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.java.lang.String
toString()
java.lang.String
type()
Deprecated.Types are in the process of being removed.DeleteRequest
type(java.lang.String type)
Deprecated.Types are in the process of being removed.ActionRequestValidationException
validate()
long
version()
Get the document version for this requestDeleteRequest
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 requestDeleteRequest
versionType(VersionType versionType)
Sets the versioning type.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, 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(StreamInput in) throws java.io.IOException
- Throws:
java.io.IOException
-
DeleteRequest
public DeleteRequest()
-
DeleteRequest
public DeleteRequest(java.lang.String index)
Constructs a new delete request against the specified index. Thetype(String)
andid(String)
must be set.
-
DeleteRequest
@Deprecated public DeleteRequest(java.lang.String index, java.lang.String type, java.lang.String id)
Deprecated.Types are in the process of being removed. UseDeleteRequest(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 fromtype
- The type of the documentid
- The id of the document
-
DeleteRequest
public DeleteRequest(java.lang.String index, java.lang.String id)
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 Detail
-
validate
public ActionRequestValidationException validate()
- Specified by:
validate
in interfaceWriteRequest<DeleteRequest>
- Overrides:
validate
in classReplicationRequest<DeleteRequest>
-
type
@Deprecated public java.lang.String type()
Deprecated.Types are in the process of being removed.The type of the document to delete.- Specified by:
type
in interfaceDocWriteRequest<DeleteRequest>
- Returns:
- the type
-
type
@Deprecated public DeleteRequest type(java.lang.String type)
Deprecated.Types are in the process of being removed.Sets the type of the document to delete.- Specified by:
type
in interfaceDocWriteRequest<DeleteRequest>
- Returns:
- the Request
-
defaultTypeIfNull
@Deprecated public DeleteRequest defaultTypeIfNull(java.lang.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 interfaceDocWriteRequest<DeleteRequest>
- Returns:
- the Request
-
id
public java.lang.String id()
The id of the document to delete.- Specified by:
id
in interfaceDocWriteRequest<DeleteRequest>
- Returns:
- the id
-
id
public DeleteRequest id(java.lang.String id)
Sets the id of the document to delete.
-
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 interfaceDocWriteRequest<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 interfaceDocWriteRequest<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 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
public DeleteRequest versionType(VersionType 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
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 withsetIfPrimaryTerm(long)
If the document last modification was assigned a different sequence number aVersionConflictEngineException
will be thrown.- Specified by:
setIfSeqNo
in interfaceDocWriteRequest<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 withsetIfSeqNo(long)
If the document last modification was assigned a different primary term aVersionConflictEngineException
will be thrown.- Specified by:
setIfPrimaryTerm
in interfaceDocWriteRequest<DeleteRequest>
-
versionType
public VersionType 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
public DocWriteRequest.OpType 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
-
writeTo
public void writeTo(StreamOutput out) throws java.io.IOException
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classReplicatedWriteRequest<DeleteRequest>
- Throws:
java.io.IOException
-
toString
public java.lang.String toString()
- Specified by:
toString
in classReplicationRequest<DeleteRequest>
-
-