Packagecom.amazonaws.services.sqs.model
Classpublic class GetQueueAttributesRequest
InheritanceGetQueueAttributesRequest Inheritance AmazonWebServiceRequest Inheritance Object

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

Container for the parameters to the GetQueueAttributes operation. Gets one or all attributes of a queue. Queues currently have nine (9) attributes you can get:



Public Methods
 MethodDefined By
  
GetQueueAttributesRequest(queueUrl:String = null)
Constructs a new GetQueueAttributesRequest object.
GetQueueAttributesRequest
  
A list of attributes to get.
GetQueueAttributesRequest
  
getQueueUrl():String
The queue URL.
GetQueueAttributesRequest
  
setAttributeNames(attributeNames:Array):void
A list of attributes to set.
GetQueueAttributesRequest
  
setQueueUrl(queueUrl:String):void
Expected queue URL format: (http|https://endpoint/12digitOwnerAccountId/QueueName).
GetQueueAttributesRequest
  
toString():String
Returns a string representation of this object; useful for testing and debugging.
GetQueueAttributesRequest
  
A list of attributes to get.
GetQueueAttributesRequest
  
Expected query URL format: (http|https://endpoint/12digitOwnerAccountId/QueueName).
GetQueueAttributesRequest
Constructor Detail
GetQueueAttributesRequest()Constructor
public function GetQueueAttributesRequest(queueUrl:String = null)

Constructs a new GetQueueAttributesRequest 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)
Method Detail
getAttributeNames()method
public function getAttributeNames():Array

A list of attributes to get.

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

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

Returns
String — queue URL
setAttributeNames()method 
public function setAttributeNames(attributeNames:Array):void

A list of attributes to set.

Parameters

attributeNames:Array — A list of attributes to set. Queues currently have nine (9) attributes you can get:
  • All - returns all values.
  • ApproximateNumberOfMessages - returns the approximate number of visible messages in a queue. For more information, see 'Resources Required to Process Messages' in the Amazon SQS Developer Guide.
  • ApproximateNumberOfMessagesNotVisible - returns the approximate number of messages that are not timed-out and not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.
  • VisibilityTimeout - returns the visibility timeout for the queue. For more information about 'visibility timeout', see 'Visibility Timeout' in the Amazon SQS Developer Guide.
  • CreatedTimestamp - returns the time when the queue was created (epoch time in seconds).
  • LastModifiedTimestamp - returns the time when the queue was last changed (epoch time in seconds).
  • Policy - returns the queue's policy.
  • MaximumMessageSize - returns the limit of how many bytes a message can contain before Amazon SQS rejects it.
  • MessageRetentionPeriod - returns the number of seconds Amazon SQS retains a message.
  • QueueArn- returns the queue's Amazon resource name (ARN).

See also

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

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

Parameters

queueUrl:String — query URL

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):GetQueueAttributesRequest

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 set. Queues currently have nine (9) attributes you can get:
  • All - returns all values.
  • ApproximateNumberOfMessages - returns the approximate number of visible messages in a queue. For more information, see 'Resources Required to Process Messages' in the Amazon SQS Developer Guide.
  • ApproximateNumberOfMessagesNotVisible - returns the approximate number of messages that are not timed-out and not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.
  • VisibilityTimeout - returns the visibility timeout for the queue. For more information about 'visibility timeout', see 'Visibility Timeout' in the Amazon SQS Developer Guide.
  • CreatedTimestamp - returns the time when the queue was created (epoch time in seconds).
  • LastModifiedTimestamp - returns the time when the queue was last changed (epoch time in seconds).
  • Policy - returns the queue's policy.
  • MaximumMessageSize - returns the limit of how many bytes a message can contain before Amazon SQS rejects it.
  • MessageRetentionPeriod - returns the number of seconds Amazon SQS retains a message.
  • QueueArn- returns the queue's Amazon resource name (ARN).

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

See also

withQueueUrl()method 
public function withQueueUrl(queueUrl:String):GetQueueAttributesRequest

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

Parameters

queueUrl:String — queue URL

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