Overview  Package   Class  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.sqs.model
Class GetQueueAttributesRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.sqs.model.GetQueueAttributesRequest

public class GetQueueAttributesRequest
extends AmazonWebServiceRequest

Container for the parameters to the GetQueueAttributes operation.

Gets attributes for the specified queue. The following attributes are supported:

See Also:
AmazonSQS.getQueueAttributes(GetQueueAttributesRequest)

Constructor Summary
GetQueueAttributesRequest()
          Default constructor for a new GetQueueAttributesRequest object.
GetQueueAttributesRequest(java.lang.String queueUrl)
          Constructs a new GetQueueAttributesRequest object.
 
Method Summary
 java.util.List<java.lang.String> getAttributeNames()
          A list of attributes to retrieve information for.
 java.lang.String getQueueUrl()
          The URL of the SQS queue to take action on.
 void setAttributeNames(java.util.Collection<java.lang.String> attributeNames)
          A list of attributes to retrieve information for.
 void setQueueUrl(java.lang.String queueUrl)
          The URL of the SQS queue to take action on.
 java.lang.String toString()
          Returns a string representation of this object; useful for testing and debugging.
 GetQueueAttributesRequest withAttributeNames(java.util.Collection<java.lang.String> attributeNames)
          A list of attributes to retrieve information for.
 GetQueueAttributesRequest withAttributeNames(java.lang.String... attributeNames)
          A list of attributes to retrieve information for.
 GetQueueAttributesRequest withQueueUrl(java.lang.String queueUrl)
          The URL of the SQS queue to take action on.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GetQueueAttributesRequest

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

GetQueueAttributesRequest

public GetQueueAttributesRequest(java.lang.String queueUrl)
Constructs a new GetQueueAttributesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:
queueUrl - The URL of the SQS queue to take action on.
Method Detail

getQueueUrl

public java.lang.String getQueueUrl()
The URL of the SQS queue to take action on.

Returns:
The URL of the SQS queue to take action on.

setQueueUrl

public void setQueueUrl(java.lang.String queueUrl)
The URL of the SQS queue to take action on.

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

withQueueUrl

public GetQueueAttributesRequest withQueueUrl(java.lang.String queueUrl)
The URL of the 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 SQS queue to take action on.
Returns:
A reference to this updated object so that method calls can be chained together.

getAttributeNames

public java.util.List<java.lang.String> getAttributeNames()
A list of attributes to retrieve information for. The following attributes are supported:

Returns:
A list of attributes to retrieve information for. The following attributes are supported:
  • 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).

setAttributeNames

public void setAttributeNames(java.util.Collection<java.lang.String> attributeNames)
A list of attributes to retrieve information for. The following attributes are supported:

Parameters:
attributeNames - A list of attributes to retrieve information for. The following attributes are supported:
  • 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).

withAttributeNames

public GetQueueAttributesRequest withAttributeNames(java.lang.String... attributeNames)
A list of attributes to retrieve information for. The following attributes are supported:

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

Parameters:
attributeNames - A list of attributes to retrieve information for. The following attributes are supported:
  • 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:
A reference to this updated object so that method calls can be chained together.

withAttributeNames

public GetQueueAttributesRequest withAttributeNames(java.util.Collection<java.lang.String> attributeNames)
A list of attributes to retrieve information for. The following attributes are supported:

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

Parameters:
attributeNames - A list of attributes to retrieve information for. The following attributes are supported:
  • 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:
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()
Overview  Package   Class  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.