com.amazonaws.services.sqs.model

Class SendMessageBatchRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sqs.model.SendMessageBatchRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SendMessageBatchRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Delivers up to ten messages to the specified queue. This is a batch version of SendMessage . For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.

The result of sending each message is reported individually in the response. 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.

The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).

The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:

#x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [ #x10000 to #x10FFFF]

For more information, see RFC1321. If you send any characters that aren't included in this list, your request will be rejected.

If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default for the queue.

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SendMessageBatchRequest() Default constructor for SendMessageBatchRequest object.
SendMessageBatchRequest(java.lang.String queueUrl) Constructs a new SendMessageBatchRequest object.
SendMessageBatchRequest(java.lang.String queueUrl, java.util.List<SendMessageBatchRequestEntry> entries) Constructs a new SendMessageBatchRequest object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.List<SendMessageBatchRequestEntry>	getEntries() A list of SendMessageBatchRequestEntry items.
java.lang.String	getQueueUrl() The URL of the Amazon SQS queue to take action on.
int	hashCode()
void	setEntries(java.util.Collection<SendMessageBatchRequestEntry> entries) A list of SendMessageBatchRequestEntry items.
void	setQueueUrl(java.lang.String queueUrl) The URL of the Amazon SQS queue to take action on.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
SendMessageBatchRequest	withEntries(java.util.Collection<SendMessageBatchRequestEntry> entries) A list of SendMessageBatchRequestEntry items.
SendMessageBatchRequest	withEntries(SendMessageBatchRequestEntry... entries) A list of SendMessageBatchRequestEntry items.
SendMessageBatchRequest	withQueueUrl(java.lang.String queueUrl) The URL of the Amazon SQS queue to take action on.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SendMessageBatchRequest

public SendMessageBatchRequest()

Default constructor for SendMessageBatchRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

SendMessageBatchRequest

public SendMessageBatchRequest(java.lang.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 Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

SendMessageBatchRequest

public SendMessageBatchRequest(java.lang.String queueUrl,
                               java.util.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 Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

entries -

A list of SendMessageBatchRequestEntry items.

Method Detail

getQueueUrl

public java.lang.String getQueueUrl()

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

Returns:

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

setQueueUrl

public void setQueueUrl(java.lang.String queueUrl)

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

Parameters:

queueUrl -

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

withQueueUrl

public SendMessageBatchRequest withQueueUrl(java.lang.String queueUrl)

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

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

Parameters:

queueUrl -

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

Returns:

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

getEntries

public java.util.List<SendMessageBatchRequestEntry> getEntries()

A list of SendMessageBatchRequestEntry items.

Returns:

A list of SendMessageBatchRequestEntry items.

setEntries

public void setEntries(java.util.Collection<SendMessageBatchRequestEntry> entries)

A list of SendMessageBatchRequestEntry items.

Parameters:

entries -

A list of SendMessageBatchRequestEntry items.

withEntries

public SendMessageBatchRequest withEntries(SendMessageBatchRequestEntry... entries)

A list of SendMessageBatchRequestEntry items.

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

Parameters:

entries -

A list of SendMessageBatchRequestEntry items.

Returns:

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

withEntries

public SendMessageBatchRequest withEntries(java.util.Collection<SendMessageBatchRequestEntry> entries)

A list of SendMessageBatchRequestEntry items.

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

Parameters:

entries -

A list of SendMessageBatchRequestEntry items.

Returns:

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

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object