com.amazonaws.services.sqs.model

Class DeleteMessageRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sqs.model.DeleteMessageRequest

All Implemented Interfaces:

Serializable

public class DeleteMessageRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DeleteMessage operation.

The DeleteMessage action unconditionally removes the specified message from the specified queue. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue.

See Also:

AmazonSQS.deleteMessage(DeleteMessageRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeleteMessageRequest() Default constructor for a new DeleteMessageRequest object.
DeleteMessageRequest(String queueUrl, String receiptHandle) Constructs a new DeleteMessageRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getQueueUrl() The URL of the 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 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 SQS queue to take action on.
DeleteMessageRequest	withReceiptHandle(String receiptHandle) The receipt handle associated with the message to delete.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeleteMessageRequest

public DeleteMessageRequest()

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

DeleteMessageRequest

public DeleteMessageRequest(String queueUrl,
                    String receiptHandle)

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

Parameters:

queueUrl - The URL of the SQS queue to take action on.

receiptHandle - The receipt handle associated with the message to delete.

Method Detail

getQueueUrl

public String getQueueUrl()

The URL of the SQS queue to take action on.

Returns:

The URL of the SQS queue to take action on.

setQueueUrl

public void setQueueUrl(String queueUrl)

The URL of the SQS queue to take action on.

Parameters:

queueUrl - The URL of the SQS queue to take action on.

withQueueUrl

public DeleteMessageRequest withQueueUrl(String queueUrl)

The URL of the SQS queue to take action on.

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

Parameters:

queueUrl - The URL of the SQS queue to take action on.

Returns:

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

getReceiptHandle

public String getReceiptHandle()

The receipt handle associated with the message to delete.

Returns:

The receipt handle associated with the message to delete.

setReceiptHandle

public void setReceiptHandle(String receiptHandle)

The receipt handle associated with the message to delete.

Parameters:

receiptHandle - The receipt handle associated with the message to delete.

withReceiptHandle

public DeleteMessageRequest withReceiptHandle(String receiptHandle)

The receipt handle associated with the message to delete.

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

Parameters:

receiptHandle - The receipt handle associated with the message to delete.

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