com.amazonaws.services.sqs.model

Class GetQueueAttributesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sqs.model.GetQueueAttributesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class GetQueueAttributesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the GetQueueAttributes operation.

Gets attributes for the specified queue. 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).
• ApproximateNumberOfMessagesDelayed - returns the approximate number of messages that are pending to be added to the queue.
• DelaySeconds - returns the default delay on the queue in seconds.
• ReceiveMessageWaitTimeSeconds - returns the time for which a ReceiveMessage call will wait for a message to arrive.
• RedrivePolicy - returns the parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues 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.

NOTE:Some API actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

&Attribute.1=this

&Attribute.2=that

See Also:

AmazonSQS.getQueueAttributes(GetQueueAttributesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetQueueAttributesRequest() Default constructor for a new GetQueueAttributesRequest object.
GetQueueAttributesRequest(String queueUrl) Constructs a new GetQueueAttributesRequest object.
GetQueueAttributesRequest(String queueUrl, List<String> attributeNames) Constructs a new GetQueueAttributesRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
GetQueueAttributesRequest	clone()
boolean	equals(Object obj)
List<String>	getAttributeNames() A list of attributes to retrieve information for.
String	getQueueUrl() The URL of the Amazon SQS queue to take action on.
int	hashCode()
void	setAttributeNames(Collection<String> attributeNames) A list of attributes to retrieve information for.
void	setQueueUrl(String queueUrl) The URL of the Amazon SQS queue to take action on.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetQueueAttributesRequest	withAttributeNames(Collection<String> attributeNames) A list of attributes to retrieve information for.
GetQueueAttributesRequest	withAttributeNames(QueueAttributeName... attributeNames) A list of attributes to retrieve information for.
GetQueueAttributesRequest	withAttributeNames(String... attributeNames) A list of attributes to retrieve information for.
GetQueueAttributesRequest	withQueueUrl(String queueUrl) The URL of the Amazon SQS queue to take action on.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, 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

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(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 Amazon SQS queue to take action on.

GetQueueAttributesRequest

public GetQueueAttributesRequest(String queueUrl,
                         List<String> attributeNames)

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

attributeNames - A list of attributes to retrieve information for.

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 GetQueueAttributesRequest 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 to retrieve information for.

Returns:

A list of attributes to retrieve information for.

setAttributeNames

public void setAttributeNames(Collection<String> attributeNames)

A list of attributes to retrieve information for.

Parameters:

attributeNames - A list of attributes to retrieve information for.

withAttributeNames

public GetQueueAttributesRequest withAttributeNames(String... attributeNames)

A list of attributes to retrieve information for.

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 to retrieve information for.

Returns:

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

withAttributeNames

public GetQueueAttributesRequest withAttributeNames(Collection<String> attributeNames)

A list of attributes to retrieve information for.

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

Parameters:

attributeNames - A list of attributes to retrieve information for.

Returns:

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

withAttributeNames

public GetQueueAttributesRequest withAttributeNames(QueueAttributeName... attributeNames)

A list of attributes to retrieve information for.

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

Parameters:

attributeNames - A list of attributes to retrieve information for.

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 GetQueueAttributesRequest clone()

Overrides:

clone in class AmazonWebServiceRequest