Packagecom.amazonaws.services.sqs.model
Classpublic class ReceiveMessageRequest
InheritanceReceiveMessageRequest Inheritance AmazonWebServiceRequest Inheritance Object

Language Version : ActionScript 3.0
Product Version : Flex 4
Since : February 1. 2011
Runtime Versions : Flash Player 10.1, AIR 2.5

Container for the parameters to the ReceiveMessage operation. Retrieves one or more messages from the specified queue, including the message body and message ID of each message. Messages returned by this action stay in the queue until you delete them. However, once a message is returned to a ReceiveMessage request, it is not returned on subsequent ReceiveMessage requests for the duration of the VisibilityTimeout. If you do not specify a VisibilityTimeout in the request, the overall visibility timeout for the queue is used for the returned messages.



Public Methods
 MethodDefined By
  
ReceiveMessageRequest(queueUrl:String = null, maxNumberOfMessages:Number, visibilityTimeout:Number)
Constructs a new ReceiveMessageRequest object.
ReceiveMessageRequest
  
A list of attributes to get.
ReceiveMessageRequest
  
The maximum number of messages to return.
ReceiveMessageRequest
  
getQueueUrl():String
The queue URL.
ReceiveMessageRequest
  
The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
ReceiveMessageRequest
  
setAttributeNames(attributeNames:Array):void
A list of attributes to set.
ReceiveMessageRequest
  
setMaxNumberOfMessages(maxNumberOfMessages:Number):void
The maximum number of messages to set.
ReceiveMessageRequest
  
setQueueUrl(queueUrl:String):void
Expected queue URL format: (http|https://endpoint/12digitOwnerAccountId/QueueName).
ReceiveMessageRequest
  
setVisibilityTimeout(visibilityTimeout:Number):void
The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
ReceiveMessageRequest
  
toString():String
Returns a string representation of this object; useful for testing and debugging.
ReceiveMessageRequest
  
A list of attributes to get.
ReceiveMessageRequest
  
The maximum number of messages to return.
ReceiveMessageRequest
  
Expected query URL format: (http|https://endpoint/12digitOwnerAccountId/QueueName).
ReceiveMessageRequest
  
The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
ReceiveMessageRequest
Constructor Detail
ReceiveMessageRequest()Constructor
public function ReceiveMessageRequest(queueUrl:String = null, maxNumberOfMessages:Number, visibilityTimeout:Number)

Constructs a new ReceiveMessageRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters
queueUrl:String (default = null) — queue URL (http|https://endpoint/12digitOwnerAccountId/QueueName)
 
maxNumberOfMessages:Number (default = NaN) — The maximum number of messages to return. If not set AWS will default to 1.
 
visibilityTimeout:Number (default = NaN) — The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request. If not set AWS will default to visibility timeout for the queue.
Method Detail
getAttributeNames()method
public function getAttributeNames():Array

A list of attributes to get.

Returns
Array — A list of attributes to get.
getMaxNumberOfMessages()method 
public function getMaxNumberOfMessages():Number

The maximum number of messages to return. Amazon SQS never returns more messages than this value but may return fewer. All of the messages are not necessarily returned.

Returns
Number — The maximum number of messages to return. Amazon SQS never returns more messages than this value but may return fewer. All of the messages are not necessarily returned.
getQueueUrl()method 
public function getQueueUrl():String

The queue URL. (http|https://endpoint/12digitOwnerAccountId/QueueName).

Returns
String — queue URL
getVisibilityTimeout()method 
public function getVisibilityTimeout():Number

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

Returns
Number — The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
setAttributeNames()method 
public function setAttributeNames(attributeNames:Array):void

A list of attributes to set.

Parameters

attributeNames:Array — list of attributes to set.

setMaxNumberOfMessages()method 
public function setMaxNumberOfMessages(maxNumberOfMessages:Number):void

The maximum number of messages to set.

Parameters

maxNumberOfMessages:Number — maximum number of messages.

setQueueUrl()method 
public function setQueueUrl(queueUrl:String):void

Expected queue URL format: (http|https://endpoint/12digitOwnerAccountId/QueueName).

Parameters

queueUrl:String — queue URL

setVisibilityTimeout()method 
public function setVisibilityTimeout(visibilityTimeout:Number):void

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

Parameters

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

toString()method 
public function toString():String

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

Returns
String — A string representation of this object.
withAttributeNames()method 
public function withAttributeNames(attributeNames:Array):ReceiveMessageRequest

A list of attributes to get. Returns a reference to this object so that method calls can be chained together.

Parameters

attributeNames:Array — A list of attributes to get.

Returns
ReceiveMessageRequest — A reference to this updated object so that method calls can be chained together.
withMaxNumberOfMessages()method 
public function withMaxNumberOfMessages(maxNumberOfMessages:Number):ReceiveMessageRequest

The maximum number of messages to return. Amazon SQS never returns more messages than this value but may return fewer. All of the messages are not necessarily returned. Returns a reference to this object so that method calls can be chained together.

Parameters

maxNumberOfMessages:Number — The maximum number of messages to return. Amazon SQS never returns more messages than this value but may return fewer.

Returns
ReceiveMessageRequest — A reference to this updated object so that method calls can be chained together.
withQueueUrl()method 
public function withQueueUrl(queueUrl:String):ReceiveMessageRequest

Expected query URL format: (http|https://endpoint/12digitOwnerAccountId/QueueName).

Parameters

queueUrl:String — queue URL

Returns
ReceiveMessageRequest — A reference to this updated object so that method calls can be chained together.
withVisibilityTimeout()method 
public function withVisibilityTimeout(visibilityTimeout:Number):ReceiveMessageRequest

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

Parameters

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

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