public class DeleteMessageRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
DeleteMessage operation
.
Deletes the specified message from the specified queue. You specify
the message by using the message's receipt handle
and not
the message ID
you received when you sent the message.
Even if the message is locked by another reader due to the visibility
timeout setting, it is still deleted from the queue. If you leave a
message in the queue for longer than the queue's configured retention
period, Amazon SQS automatically deletes it.
NOTE: The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. When you request DeleteMessage, if you don't provide the most recently received receipt handle for the message, the request will still succeed, but the message might not be deleted.
IMPORTANT: It is possible you will receive a message even after you have deleted it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you request to delete the message. The copy remains on the server and might be returned to you again on a subsequent receive request. You should create your system to be idempotent so that receiving a particular message more than once is not a problem.
NOOP
Constructor and Description |
---|
DeleteMessageRequest()
Default constructor for a new DeleteMessageRequest object.
|
DeleteMessageRequest(String queueUrl,
String receiptHandle)
Constructs a new DeleteMessageRequest object.
|
Modifier and Type | Method and Description |
---|---|
DeleteMessageRequest |
clone() |
boolean |
equals(Object obj) |
String |
getQueueUrl()
The URL of the Amazon SQS queue to take action on.
|
String |
getReceiptHandle()
The receipt handle associated with the message to delete.
|
int |
hashCode() |
void |
setQueueUrl(String queueUrl)
The URL of the Amazon SQS queue to take action on.
|
void |
setReceiptHandle(String receiptHandle)
The receipt handle associated with the message to delete.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DeleteMessageRequest |
withQueueUrl(String queueUrl)
The URL of the Amazon SQS queue to take action on.
|
DeleteMessageRequest |
withReceiptHandle(String receiptHandle)
The receipt handle associated with the message to delete.
|
copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public DeleteMessageRequest()
public DeleteMessageRequest(String queueUrl, String receiptHandle)
queueUrl
- The URL of the Amazon SQS queue to take action on.receiptHandle
- The receipt handle associated with the message to
delete.public String getQueueUrl()
public void setQueueUrl(String queueUrl)
queueUrl
- The URL of the Amazon SQS queue to take action on.public DeleteMessageRequest withQueueUrl(String queueUrl)
Returns a reference to this object so that method calls can be chained together.
queueUrl
- The URL of the Amazon SQS queue to take action on.public String getReceiptHandle()
public void setReceiptHandle(String receiptHandle)
receiptHandle
- The receipt handle associated with the message to delete.public DeleteMessageRequest withReceiptHandle(String receiptHandle)
Returns a reference to this object so that method calls can be chained together.
receiptHandle
- The receipt handle associated with the message to delete.public String toString()
toString
in class Object
Object.toString()
public DeleteMessageRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2015. All rights reserved.