com.amazonaws.services.sqs.model
Class SendMessageBatchRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.sqs.model.SendMessageBatchRequest

public class SendMessageBatchRequest
extends AmazonWebServiceRequest

Container for the parameters to the SendMessageBatch operation.

This is a batch version of SendMessage. It takes multiple messages and adds each of them to the queue. The result of each add operation is reported individually in the response.

See Also:

AmazonSQS.sendMessageBatch(SendMessageBatchRequest)

Constructor Summary

SendMessageBatchRequest()
Default constructor for a new SendMessageBatchRequest object.

SendMessageBatchRequest(String queueUrl)
Constructs a new SendMessageBatchRequest object.

SendMessageBatchRequest(String queueUrl, List<SendMessageBatchRequestEntry> entries)
Constructs a new SendMessageBatchRequest object.

Method Summary

List<SendMessageBatchRequestEntry>	getEntries() A list of SendMessageBatchRequestEntrys.
String	getQueueUrl() The URL of the SQS queue to take action on.
void	setEntries(Collection<SendMessageBatchRequestEntry> entries) A list of SendMessageBatchRequestEntrys.
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.
SendMessageBatchRequest	withEntries(Collection<SendMessageBatchRequestEntry> entries) A list of SendMessageBatchRequestEntrys.
SendMessageBatchRequest	withEntries(SendMessageBatchRequestEntry... entries) A list of SendMessageBatchRequestEntrys.
SendMessageBatchRequest	withQueueUrl(String queueUrl) The URL of the SQS queue to take action on.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SendMessageBatchRequest

public SendMessageBatchRequest()

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

SendMessageBatchRequest

public SendMessageBatchRequest(String queueUrl)

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

SendMessageBatchRequest

public SendMessageBatchRequest(String queueUrl,
                               List<SendMessageBatchRequestEntry> entries)

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

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 SendMessageBatchRequest 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<SendMessageBatchRequestEntry> getEntries()

A list of SendMessageBatchRequestEntrys.

Returns:

A list of SendMessageBatchRequestEntrys.

setEntries

public void setEntries(Collection<SendMessageBatchRequestEntry> entries)

A list of SendMessageBatchRequestEntrys.

Parameters:

entries - A list of SendMessageBatchRequestEntrys.

withEntries

public SendMessageBatchRequest withEntries(SendMessageBatchRequestEntry... entries)

A list of SendMessageBatchRequestEntrys.

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

Parameters:

entries - A list of SendMessageBatchRequestEntrys.

Returns:

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

withEntries

public SendMessageBatchRequest withEntries(Collection<SendMessageBatchRequestEntry> entries)

A list of SendMessageBatchRequestEntrys.

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

Parameters:

entries - A list of SendMessageBatchRequestEntrys.

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()