com.amazonaws.services.sqs.model

Class PurgeQueueRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sqs.model.PurgeQueueRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class PurgeQueueRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the 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.

See Also:

AmazonSQS.purgeQueue(PurgeQueueRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PurgeQueueRequest() Default constructor for a new PurgeQueueRequest object.
PurgeQueueRequest(String queueUrl) Constructs a new PurgeQueueRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
PurgeQueueRequest	clone()
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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PurgeQueueRequest

public PurgeQueueRequest()

Default constructor for a new PurgeQueueRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

PurgeQueueRequest

public PurgeQueueRequest(String queueUrl)

Constructs a new PurgeQueueRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

queueUrl - The queue URL of the queue to delete the messages from when using the PurgeQueue API.

Method Detail

getQueueUrl

public String getQueueUrl()

The queue URL of the queue to delete the messages from when using the PurgeQueue API.

Returns:

The queue URL of the queue to delete the messages from when using the PurgeQueue API.

setQueueUrl

public void setQueueUrl(String queueUrl)

The queue URL of the queue to delete the messages from when using the PurgeQueue API.

Parameters:

queueUrl - The queue URL of the queue to delete the messages from when using the PurgeQueue API.

withQueueUrl

public PurgeQueueRequest withQueueUrl(String queueUrl)

The queue URL of the queue to delete the messages from when using the PurgeQueue API.

Returns a reference to this object so that method calls can be chained together.

Parameters:

queueUrl - The queue URL of the queue to delete the messages from when using the PurgeQueue API.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public PurgeQueueRequest clone()

Overrides:

clone in class AmazonWebServiceRequest