public class PurgeQueueRequest extends AmazonWebServiceRequest implements Serializable
PurgeQueue operation
.
Deletes the messages in a queue specified by the queue URL .
IMPORTANT:When you use the PurgeQueue API, the deleted messages in the queue cannot be retrieved.
When you purge a queue, the message deletion process takes up to 60
seconds. All messages sent to the queue before calling
PurgeQueue
will be deleted; messages sent to the queue
while it is being purged may be deleted. While the queue is being
purged, messages sent to the queue before PurgeQueue
was
called may be received, but will be deleted within the next minute.
NOOP
Constructor and Description |
---|
PurgeQueueRequest()
Default constructor for a new PurgeQueueRequest object.
|
PurgeQueueRequest(String queueUrl)
Constructs a new PurgeQueueRequest object.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
String |
getQueueUrl()
The queue URL of the queue to delete the messages from when using the
PurgeQueue API. |
int |
hashCode() |
void |
setQueueUrl(String queueUrl)
The queue URL of the queue to delete the messages from when using the
PurgeQueue API. |
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
PurgeQueueRequest |
withQueueUrl(String queueUrl)
The queue URL of the queue to delete the messages from when using the
PurgeQueue API. |
copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public PurgeQueueRequest()
public PurgeQueueRequest(String queueUrl)
queueUrl
- The queue URL of the queue to delete the messages from
when using the PurgeQueue
API.public String getQueueUrl()
PurgeQueue
API.PurgeQueue
API.public void setQueueUrl(String queueUrl)
PurgeQueue
API.queueUrl
- The queue URL of the queue to delete the messages from when using the
PurgeQueue
API.public PurgeQueueRequest withQueueUrl(String queueUrl)
PurgeQueue
API.
Returns a reference to this object so that method calls can be chained together.
queueUrl
- The queue URL of the queue to delete the messages from when using the
PurgeQueue
API.public String toString()
toString
in class Object
Object.toString()
Copyright © 2015. All rights reserved.