com.amazonaws.services.sqs.model

Class ReceiveMessageRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sqs.model.ReceiveMessageRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ReceiveMessageRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the ReceiveMessage operation.

Retrieves one or more messages, with a maximum limit of 10 messages, from the specified queue. Long poll support is enabled by using the WaitTimeSeconds parameter. For more information, see Amazon SQS Long Poll in the Amazon SQS Developer Guide .

Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. This means only the messages on the sampled machines are returned. If the number of messages in the queue is small (less than 1000), it is likely you will get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular ReceiveMessage response; in which case you should repeat the request.

For each message returned, the response includes the following:

• Message body

• MD5 digest of the message body. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html .

• Message ID you received when you sent the message to the queue.

• Receipt handle.

• Message attributes.

• MD5 digest of the message attributes.

The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide .

You can provide the VisibilityTimeout parameter in your request, which will be applied to the messages that Amazon SQS returns in the response. If you do not include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer Guide .

NOTE: Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

See Also:

AmazonSQS.receiveMessage(ReceiveMessageRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ReceiveMessageRequest() Default constructor for a new ReceiveMessageRequest object.
ReceiveMessageRequest(String queueUrl) Constructs a new ReceiveMessageRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
ReceiveMessageRequest	clone()
boolean	equals(Object obj)
List<String>	getAttributeNames() A list of attributes that need to be returned along with each message.
Integer	getMaxNumberOfMessages() The maximum number of messages to return.
List<String>	getMessageAttributeNames() The name of the message attribute, where N is the index.
String	getQueueUrl() The URL of the Amazon SQS queue to take action on.
Integer	getVisibilityTimeout() The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
Integer	getWaitTimeSeconds() The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning.
int	hashCode()
void	setAttributeNames(Collection<String> attributeNames) A list of attributes that need to be returned along with each message.
void	setMaxNumberOfMessages(Integer maxNumberOfMessages) The maximum number of messages to return.
void	setMessageAttributeNames(Collection<String> messageAttributeNames) The name of the message attribute, where N is the index.
void	setQueueUrl(String queueUrl) The URL of the Amazon SQS queue to take action on.
void	setVisibilityTimeout(Integer visibilityTimeout) The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
void	setWaitTimeSeconds(Integer waitTimeSeconds) The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ReceiveMessageRequest	withAttributeNames(Collection<String> attributeNames) A list of attributes that need to be returned along with each message.
ReceiveMessageRequest	withAttributeNames(QueueAttributeName... attributeNames) A list of attributes that need to be returned along with each message.
ReceiveMessageRequest	withAttributeNames(String... attributeNames) A list of attributes that need to be returned along with each message.
ReceiveMessageRequest	withMaxNumberOfMessages(Integer maxNumberOfMessages) The maximum number of messages to return.
ReceiveMessageRequest	withMessageAttributeNames(Collection<String> messageAttributeNames) The name of the message attribute, where N is the index.
ReceiveMessageRequest	withMessageAttributeNames(String... messageAttributeNames) The name of the message attribute, where N is the index.
ReceiveMessageRequest	withQueueUrl(String queueUrl) The URL of the Amazon SQS queue to take action on.
ReceiveMessageRequest	withVisibilityTimeout(Integer visibilityTimeout) The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
ReceiveMessageRequest	withWaitTimeSeconds(Integer waitTimeSeconds) The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ReceiveMessageRequest

public ReceiveMessageRequest()

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

ReceiveMessageRequest

public ReceiveMessageRequest(String queueUrl)

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

Method Detail

getQueueUrl

public String getQueueUrl()

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

Returns:

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

setQueueUrl

public void setQueueUrl(String queueUrl)

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

Parameters:

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

withQueueUrl

public ReceiveMessageRequest withQueueUrl(String queueUrl)

The URL of the Amazon 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 Amazon SQS queue to take action on.

Returns:

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

getAttributeNames

public List<String> getAttributeNames()

A list of attributes that need to be returned along with each message.

The following lists the names and descriptions of the attributes that can be returned:

• All - returns all values.
• ApproximateFirstReceiveTimestamp - returns the time when the message was first received from the queue (epoch time in milliseconds).
• ApproximateReceiveCount - returns the number of times a message has been received from the queue but not deleted.
• SenderId - returns the AWS account number (or the IP address, if anonymous access is allowed) of the sender.
• SentTimestamp - returns the time when the message was sent to the queue (epoch time in milliseconds).

Returns:

A list of attributes that need to be returned along with each message.

The following lists the names and descriptions of the attributes that can be returned:

• All - returns all values.
• ApproximateFirstReceiveTimestamp - returns the time when the message was first received from the queue (epoch time in milliseconds).
• ApproximateReceiveCount - returns the number of times a message has been received from the queue but not deleted.
• SenderId - returns the AWS account number (or the IP address, if anonymous access is allowed) of the sender.
• SentTimestamp - returns the time when the message was sent to the queue (epoch time in milliseconds).

setAttributeNames

public void setAttributeNames(Collection<String> attributeNames)

A list of attributes that need to be returned along with each message.

The following lists the names and descriptions of the attributes that can be returned:

• All - returns all values.
• ApproximateFirstReceiveTimestamp - returns the time when the message was first received from the queue (epoch time in milliseconds).
• ApproximateReceiveCount - returns the number of times a message has been received from the queue but not deleted.
• SenderId - returns the AWS account number (or the IP address, if anonymous access is allowed) of the sender.
• SentTimestamp - returns the time when the message was sent to the queue (epoch time in milliseconds).

Parameters:

attributeNames - A list of attributes that need to be returned along with each message.

The following lists the names and descriptions of the attributes that can be returned:

• All - returns all values.
• ApproximateFirstReceiveTimestamp - returns the time when the message was first received from the queue (epoch time in milliseconds).
• ApproximateReceiveCount - returns the number of times a message has been received from the queue but not deleted.
• SenderId - returns the AWS account number (or the IP address, if anonymous access is allowed) of the sender.
• SentTimestamp - returns the time when the message was sent to the queue (epoch time in milliseconds).

withAttributeNames

public ReceiveMessageRequest withAttributeNames(String... attributeNames)

A list of attributes that need to be returned along with each message.

The following lists the names and descriptions of the attributes that can be returned:

• All - returns all values.
• ApproximateFirstReceiveTimestamp - returns the time when the message was first received from the queue (epoch time in milliseconds).
• ApproximateReceiveCount - returns the number of times a message has been received from the queue but not deleted.
• SenderId - returns the AWS account number (or the IP address, if anonymous access is allowed) of the sender.
• SentTimestamp - returns the time when the message was sent to the queue (epoch time in milliseconds).

NOTE: This method appends the values to the existing list (if any). Use setAttributeNames(java.util.Collection) or withAttributeNames(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.

Parameters:

attributeNames - A list of attributes that need to be returned along with each message.

The following lists the names and descriptions of the attributes that can be returned:

• All - returns all values.
• ApproximateFirstReceiveTimestamp - returns the time when the message was first received from the queue (epoch time in milliseconds).
• ApproximateReceiveCount - returns the number of times a message has been received from the queue but not deleted.
• SenderId - returns the AWS account number (or the IP address, if anonymous access is allowed) of the sender.
• SentTimestamp - returns the time when the message was sent to the queue (epoch time in milliseconds).

Returns:

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

withAttributeNames

public ReceiveMessageRequest withAttributeNames(Collection<String> attributeNames)

A list of attributes that need to be returned along with each message.

The following lists the names and descriptions of the attributes that can be returned:

• All - returns all values.
• ApproximateFirstReceiveTimestamp - returns the time when the message was first received from the queue (epoch time in milliseconds).
• ApproximateReceiveCount - returns the number of times a message has been received from the queue but not deleted.
• SenderId - returns the AWS account number (or the IP address, if anonymous access is allowed) of the sender.
• SentTimestamp - returns the time when the message was sent to the queue (epoch time in milliseconds).

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

Parameters:

attributeNames - A list of attributes that need to be returned along with each message.

The following lists the names and descriptions of the attributes that can be returned:

• All - returns all values.
• ApproximateFirstReceiveTimestamp - returns the time when the message was first received from the queue (epoch time in milliseconds).
• ApproximateReceiveCount - returns the number of times a message has been received from the queue but not deleted.
• SenderId - returns the AWS account number (or the IP address, if anonymous access is allowed) of the sender.
• SentTimestamp - returns the time when the message was sent to the queue (epoch time in milliseconds).

Returns:

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

withAttributeNames

public ReceiveMessageRequest withAttributeNames(QueueAttributeName... attributeNames)

A list of attributes that need to be returned along with each message.

The following lists the names and descriptions of the attributes that can be returned:

• All - returns all values.
• ApproximateFirstReceiveTimestamp - returns the time when the message was first received from the queue (epoch time in milliseconds).
• ApproximateReceiveCount - returns the number of times a message has been received from the queue but not deleted.
• SenderId - returns the AWS account number (or the IP address, if anonymous access is allowed) of the sender.
• SentTimestamp - returns the time when the message was sent to the queue (epoch time in milliseconds).

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

Parameters:

attributeNames - A list of attributes that need to be returned along with each message.

The following lists the names and descriptions of the attributes that can be returned:

• All - returns all values.
• ApproximateFirstReceiveTimestamp - returns the time when the message was first received from the queue (epoch time in milliseconds).
• ApproximateReceiveCount - returns the number of times a message has been received from the queue but not deleted.
• SenderId - returns the AWS account number (or the IP address, if anonymous access is allowed) of the sender.
• SentTimestamp - returns the time when the message was sent to the queue (epoch time in milliseconds).

Returns:

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

getMessageAttributeNames

public List<String> getMessageAttributeNames()

The name of the message attribute, where N is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name cannot start with "AWS." or "Amazon." (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.

When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying "All" or ".*" in your request. You can also use "foo.*" to return all message attributes starting with the "foo" prefix.

Returns:

The name of the message attribute, where N is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name cannot start with "AWS." or "Amazon." (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.

When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying "All" or ".*" in your request. You can also use "foo.*" to return all message attributes starting with the "foo" prefix.

setMessageAttributeNames

public void setMessageAttributeNames(Collection<String> messageAttributeNames)

The name of the message attribute, where N is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name cannot start with "AWS." or "Amazon." (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.

When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying "All" or ".*" in your request. You can also use "foo.*" to return all message attributes starting with the "foo" prefix.

Parameters:

messageAttributeNames - The name of the message attribute, where N is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name cannot start with "AWS." or "Amazon." (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.

When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying "All" or ".*" in your request. You can also use "foo.*" to return all message attributes starting with the "foo" prefix.

withMessageAttributeNames

public ReceiveMessageRequest withMessageAttributeNames(String... messageAttributeNames)

The name of the message attribute, where N is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name cannot start with "AWS." or "Amazon." (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.

When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying "All" or ".*" in your request. You can also use "foo.*" to return all message attributes starting with the "foo" prefix.

NOTE: This method appends the values to the existing list (if any). Use setMessageAttributeNames(java.util.Collection) or withMessageAttributeNames(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.

Parameters:

messageAttributeNames - The name of the message attribute, where N is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name cannot start with "AWS." or "Amazon." (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.

When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying "All" or ".*" in your request. You can also use "foo.*" to return all message attributes starting with the "foo" prefix.

Returns:

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

withMessageAttributeNames

public ReceiveMessageRequest withMessageAttributeNames(Collection<String> messageAttributeNames)

The name of the message attribute, where N is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name cannot start with "AWS." or "Amazon." (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.

When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying "All" or ".*" in your request. You can also use "foo.*" to return all message attributes starting with the "foo" prefix.

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

Parameters:

messageAttributeNames - The name of the message attribute, where N is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name cannot start with "AWS." or "Amazon." (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.

When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying "All" or ".*" in your request. You can also use "foo.*" to return all message attributes starting with the "foo" prefix.

Returns:

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

getMaxNumberOfMessages

public Integer getMaxNumberOfMessages()

The maximum number of messages to return. Amazon SQS never returns more messages than this value but may return fewer. Values can be from 1 to 10. Default is 1.

All of the messages are not necessarily returned.

Returns:

The maximum number of messages to return. Amazon SQS never returns more messages than this value but may return fewer. Values can be from 1 to 10. Default is 1.

All of the messages are not necessarily returned.

setMaxNumberOfMessages

public void setMaxNumberOfMessages(Integer maxNumberOfMessages)

The maximum number of messages to return. Amazon SQS never returns more messages than this value but may return fewer. Values can be from 1 to 10. Default is 1.

All of the messages are not necessarily returned.

Parameters:

maxNumberOfMessages - The maximum number of messages to return. Amazon SQS never returns more messages than this value but may return fewer. Values can be from 1 to 10. Default is 1.

All of the messages are not necessarily returned.

withMaxNumberOfMessages

public ReceiveMessageRequest withMaxNumberOfMessages(Integer maxNumberOfMessages)

The maximum number of messages to return. Amazon SQS never returns more messages than this value but may return fewer. Values can be from 1 to 10. Default is 1.

All of the messages are not necessarily returned.

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

Parameters:

maxNumberOfMessages - The maximum number of messages to return. Amazon SQS never returns more messages than this value but may return fewer. Values can be from 1 to 10. Default is 1.

All of the messages are not necessarily returned.

Returns:

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

getVisibilityTimeout

public Integer getVisibilityTimeout()

The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

Returns:

The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

setVisibilityTimeout

public void setVisibilityTimeout(Integer visibilityTimeout)

The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

Parameters:

visibilityTimeout - The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

withVisibilityTimeout

public ReceiveMessageRequest withVisibilityTimeout(Integer visibilityTimeout)

The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

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

Parameters:

visibilityTimeout - The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

Returns:

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

getWaitTimeSeconds

public Integer getWaitTimeSeconds()

The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning. If a message is available, the call will return sooner than WaitTimeSeconds.

Returns:

The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning. If a message is available, the call will return sooner than WaitTimeSeconds.

setWaitTimeSeconds

public void setWaitTimeSeconds(Integer waitTimeSeconds)

The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning. If a message is available, the call will return sooner than WaitTimeSeconds.

Parameters:

waitTimeSeconds - The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning. If a message is available, the call will return sooner than WaitTimeSeconds.

withWaitTimeSeconds

public ReceiveMessageRequest withWaitTimeSeconds(Integer waitTimeSeconds)

The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning. If a message is available, the call will return sooner than WaitTimeSeconds.

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

Parameters:

waitTimeSeconds - The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning. If a message is available, the call will return sooner than WaitTimeSeconds.

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

clone

public ReceiveMessageRequest clone()

Overrides:

clone in class AmazonWebServiceRequest