Packagecom.amazonaws.services.sqs.model
Classpublic class CreateQueueRequest
InheritanceCreateQueueRequest Inheritance AmazonWebServiceRequest Inheritance Object

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

Container for the parameters to the CreateQueue operation. The CreateQueue action creates a new queue, or returns the URL of an existing one. When you request CreateQueue, you provide a name for the queue. To successfully create a new queue, you must provide a name that is unique within the scope of your own queues. If you provide the name of an existing queue, a new queue isn't created and an error isn't returned. Instead, the request succeeds and the queue URL for the existing queue is returned.

IMPORTANT: If you provide a value for DefaultVisibilityTimeout that is different from the value for the existing queue, you receive an error.



Public Methods
 MethodDefined By
  
CreateQueueRequest(queueName:String = null, defaultVisibilityTimeout:Number)
Constructs a new CreateQueueRequest object.
CreateQueueRequest
  
The visibility timeout (in seconds) to use for the created queue.
CreateQueueRequest
  
getQueueName():String
The name to use for the created queue.
CreateQueueRequest
  
setDefaultVisibilityTimeout(defaultVisibilityTimeout:Number):void
The visibility timeout (in seconds) to use for the created queue.
CreateQueueRequest
  
setQueueName(queueName:String):void
The name to use for the created queue.
CreateQueueRequest
  
toString():String
Returns a string representation of this object; useful for testing and debugging.
CreateQueueRequest
  
withDefaultVisibilityTimeout(defaultVisibilityTimeout:Number):CreateQueueRequest
The visibility timeout (in seconds) to use for the created queue.
CreateQueueRequest
  
The name to use for the created queue.
CreateQueueRequest
Constructor Detail
CreateQueueRequest()Constructor
public function CreateQueueRequest(queueName:String = null, defaultVisibilityTimeout:Number)

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

Parameters
queueName:String (default = null) — The name to use for the created queue.
 
defaultVisibilityTimeout:Number (default = NaN) — The visibility timeout (in seconds) to use for the created queue.
Method Detail
getDefaultVisibilityTimeout()method
public function getDefaultVisibilityTimeout():Number

The visibility timeout (in seconds) to use for the created queue.

Returns
Number — The visibility timeout (in seconds) to use for the created queue.
getQueueName()method 
public function getQueueName():String

The name to use for the created queue.

Returns
String — The name to use for the created queue.
setDefaultVisibilityTimeout()method 
public function setDefaultVisibilityTimeout(defaultVisibilityTimeout:Number):void

The visibility timeout (in seconds) to use for the created queue.

Parameters

defaultVisibilityTimeout:Number — - The length of time (in seconds) that a message that has been received from a queue will be invisible to other receiving components when they ask to receive messages. During the visibility timeout, the component that received the message usually processes the message and then deletes it from the queue.

setQueueName()method 
public function setQueueName(queueName:String):void

The name to use for the created queue.

Parameters

queueName:String

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.
withDefaultVisibilityTimeout()method 
public function withDefaultVisibilityTimeout(defaultVisibilityTimeout:Number):CreateQueueRequest

The visibility timeout (in seconds) to use for the created queue.

Parameters

defaultVisibilityTimeout:Number — - The length of time (in seconds) that a message that has been received from a queue will be invisible to other receiving components when they ask to receive messages. During the visibility timeout, the component that received the message usually processes the message and then deletes it from the queue.

Returns
CreateQueueRequest — A reference to this updated object so that method calls can be chained together.
withQueueName()method 
public function withQueueName(queueName:String):CreateQueueRequest

The name to use for the created queue. Returns a reference to this object so that method calls can be chained together.

Parameters

queueName:String — The name to use for the created queue.

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