com.amazonaws.services.sqs.model

Class DeleteMessageBatchRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sqs.model.DeleteMessageBatchRequest

All Implemented Interfaces:

Serializable

public class DeleteMessageBatchRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DeleteMessageBatch operation.

This is a batch version of DeleteMessage. It takes multiple receipt handles and deletes each one of the messages. The result of the delete operation on each message is reported individually in the response.

See Also:

AmazonSQS.deleteMessageBatch(DeleteMessageBatchRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeleteMessageBatchRequest() Default constructor for a new DeleteMessageBatchRequest object.
DeleteMessageBatchRequest(String queueUrl) Constructs a new DeleteMessageBatchRequest object.
DeleteMessageBatchRequest(String queueUrl, List<DeleteMessageBatchRequestEntry> entries) Constructs a new DeleteMessageBatchRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<DeleteMessageBatchRequestEntry>	getEntries() A list of receipt handles for the messages to be deleted.
String	getQueueUrl() The URL of the SQS queue to take action on.
int	hashCode()
void	setEntries(Collection<DeleteMessageBatchRequestEntry> entries) A list of receipt handles for the messages to be deleted.
void	setQueueUrl(String queueUrl) The URL of the SQS queue to take action on.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DeleteMessageBatchRequest	withEntries(Collection<DeleteMessageBatchRequestEntry> entries) A list of receipt handles for the messages to be deleted.
DeleteMessageBatchRequest	withEntries(DeleteMessageBatchRequestEntry... entries) A list of receipt handles for the messages to be deleted.
DeleteMessageBatchRequest	withQueueUrl(String queueUrl) The URL of the SQS queue to take action on.

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

DeleteMessageBatchRequest

public DeleteMessageBatchRequest()

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

DeleteMessageBatchRequest

public DeleteMessageBatchRequest(String queueUrl)

Constructs a new DeleteMessageBatchRequest 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.

DeleteMessageBatchRequest

public DeleteMessageBatchRequest(String queueUrl,
                         List<DeleteMessageBatchRequestEntry> entries)

Constructs a new DeleteMessageBatchRequest 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.

entries - A list of receipt handles for the messages to be deleted.

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 DeleteMessageBatchRequest 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.

getEntries

public List<DeleteMessageBatchRequestEntry> getEntries()

A list of receipt handles for the messages to be deleted.

Returns:

A list of receipt handles for the messages to be deleted.

setEntries

public void setEntries(Collection<DeleteMessageBatchRequestEntry> entries)

A list of receipt handles for the messages to be deleted.

Parameters:

entries - A list of receipt handles for the messages to be deleted.

withEntries

public DeleteMessageBatchRequest withEntries(DeleteMessageBatchRequestEntry... entries)

A list of receipt handles for the messages to be deleted.

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

Parameters:

entries - A list of receipt handles for the messages to be deleted.

Returns:

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

withEntries

public DeleteMessageBatchRequest withEntries(Collection<DeleteMessageBatchRequestEntry> entries)

A list of receipt handles for the messages to be deleted.

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

Parameters:

entries - A list of receipt handles for the messages to be deleted.

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