public class DeleteMessageBatchRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
DeleteMessageBatch operation
.
Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage. The result of the delete action on each message is reported individually in the response.
IMPORTANT: Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
NOTE:Some API actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=this
&Attribute.2=that
NOOP
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.
|
Modifier and Type | Method and Description |
---|---|
DeleteMessageBatchRequest |
clone() |
boolean |
equals(Object obj) |
List<DeleteMessageBatchRequestEntry> |
getEntries()
A list of receipt handles for the messages to be deleted.
|
String |
getQueueUrl()
The URL of the Amazon 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 Amazon 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 Amazon SQS queue to take action on.
|
copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public DeleteMessageBatchRequest()
public DeleteMessageBatchRequest(String queueUrl)
queueUrl
- The URL of the Amazon SQS queue to take action on.public DeleteMessageBatchRequest(String queueUrl, List<DeleteMessageBatchRequestEntry> entries)
queueUrl
- The URL of the Amazon SQS queue to take action on.entries
- A list of receipt handles for the messages to be
deleted.public String getQueueUrl()
public void setQueueUrl(String queueUrl)
queueUrl
- The URL of the Amazon SQS queue to take action on.public DeleteMessageBatchRequest 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 List<DeleteMessageBatchRequestEntry> getEntries()
public void setEntries(Collection<DeleteMessageBatchRequestEntry> entries)
entries
- A list of receipt handles for the messages to be deleted.public DeleteMessageBatchRequest withEntries(DeleteMessageBatchRequestEntry... entries)
NOTE: This method appends the values to the existing list (if
any). Use setEntries(java.util.Collection)
or withEntries(java.util.Collection)
if you want to override the
existing values.
Returns a reference to this object so that method calls can be chained together.
entries
- A list of receipt handles for the messages to be deleted.public DeleteMessageBatchRequest withEntries(Collection<DeleteMessageBatchRequestEntry> entries)
Returns a reference to this object so that method calls can be chained together.
entries
- A list of receipt handles for the messages to be deleted.public String toString()
toString
in class Object
Object.toString()
public DeleteMessageBatchRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2015. All rights reserved.