com.amazonaws.services.sqs.model

Class GetQueueAttributesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sqs.model.GetQueueAttributesRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class GetQueueAttributesRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Gets attributes for the specified queue.

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:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.List<java.lang.String>	getAttributeNames() A list of attributes for which to retrieve information.
java.lang.String	getQueueUrl() The URL of the Amazon SQS queue to take action on.
int	hashCode()
void	setAttributeNames(java.util.Collection<java.lang.String> attributeNames) A list of attributes for which to retrieve information.
void	setQueueUrl(java.lang.String queueUrl) The URL of the Amazon 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 for which to retrieve information.
GetQueueAttributesRequest	withAttributeNames(java.lang.String... attributeNames) A list of attributes for which to retrieve information.
GetQueueAttributesRequest	withQueueUrl(java.lang.String queueUrl) The URL of the Amazon SQS queue to take action on.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetQueueAttributesRequest

public GetQueueAttributesRequest()

Default constructor for GetQueueAttributesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

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

Queue URLs are case-sensitive.

GetQueueAttributesRequest

public GetQueueAttributesRequest(java.lang.String queueUrl,
                                 java.util.List<java.lang.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.

Queue URLs are case-sensitive.

attributeNames -

A list of attributes for which to retrieve information.

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.

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.

• ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages that are waiting to be added to the queue.

• ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that have not timed-out and are not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

• CreatedTimestamp - Returns the time when the queue was created in seconds (epoch time).

• DelaySeconds - Returns the default delay on the queue in seconds.

• LastModifiedTimestamp - Returns the time when the queue was last changed in seconds (epoch time).

• MaximumMessageSize - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

• MessageRetentionPeriod - Returns the number of seconds for which Amazon SQS retains a message.

• Policy - Returns the policy of the queue.

• QueueArn - Returns the Amazon resource name (ARN) of the queue.

• ReceiveMessageWaitTimeSeconds - Returns the number of seconds for which 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 the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

• VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

The following attributes apply only to FIFO (first-in-first-out) queues:

• FifoQueue - Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon SQS Developer Guide.

• ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

Method Detail

getQueueUrl

public java.lang.String getQueueUrl()

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

Returns:

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

setQueueUrl

public void setQueueUrl(java.lang.String queueUrl)

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

Parameters:

queueUrl -

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

withQueueUrl

public GetQueueAttributesRequest withQueueUrl(java.lang.String queueUrl)

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

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.

Queue URLs are case-sensitive.

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

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.

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.

• ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages that are waiting to be added to the queue.

• ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that have not timed-out and are not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

• CreatedTimestamp - Returns the time when the queue was created in seconds (epoch time).

• DelaySeconds - Returns the default delay on the queue in seconds.

• LastModifiedTimestamp - Returns the time when the queue was last changed in seconds (epoch time).

• MaximumMessageSize - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

• MessageRetentionPeriod - Returns the number of seconds for which Amazon SQS retains a message.

• Policy - Returns the policy of the queue.

• QueueArn - Returns the Amazon resource name (ARN) of the queue.

• ReceiveMessageWaitTimeSeconds - Returns the number of seconds for which 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 the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

• VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

The following attributes apply only to FIFO (first-in-first-out) queues:

• FifoQueue - Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon SQS Developer Guide.

• ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

Returns:

A list of attributes for which to retrieve information.

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.

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.

• ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages that are waiting to be added to the queue.

• ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that have not timed-out and are not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

• CreatedTimestamp - Returns the time when the queue was created in seconds (epoch time).

• DelaySeconds - Returns the default delay on the queue in seconds.

• LastModifiedTimestamp - Returns the time when the queue was last changed in seconds (epoch time).

• MaximumMessageSize - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

• MessageRetentionPeriod - Returns the number of seconds for which Amazon SQS retains a message.

• Policy - Returns the policy of the queue.

• QueueArn - Returns the Amazon resource name (ARN) of the queue.

• ReceiveMessageWaitTimeSeconds - Returns the number of seconds for which 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 the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

• VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

The following attributes apply only to FIFO (first-in-first-out) queues:

• FifoQueue - Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon SQS Developer Guide.

• ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

setAttributeNames

public void setAttributeNames(java.util.Collection<java.lang.String> attributeNames)

A list of attributes for which to retrieve information.

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.

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.

• ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages that are waiting to be added to the queue.

• ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that have not timed-out and are not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

• CreatedTimestamp - Returns the time when the queue was created in seconds (epoch time).

• DelaySeconds - Returns the default delay on the queue in seconds.

• LastModifiedTimestamp - Returns the time when the queue was last changed in seconds (epoch time).

• MaximumMessageSize - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

• MessageRetentionPeriod - Returns the number of seconds for which Amazon SQS retains a message.

• Policy - Returns the policy of the queue.

• QueueArn - Returns the Amazon resource name (ARN) of the queue.

• ReceiveMessageWaitTimeSeconds - Returns the number of seconds for which 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 the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

• VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

The following attributes apply only to FIFO (first-in-first-out) queues:

• FifoQueue - Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon SQS Developer Guide.

• ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

Parameters:

attributeNames -

A list of attributes for which to retrieve information.

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.

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.

• ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages that are waiting to be added to the queue.

• ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that have not timed-out and are not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

• CreatedTimestamp - Returns the time when the queue was created in seconds (epoch time).

• DelaySeconds - Returns the default delay on the queue in seconds.

• LastModifiedTimestamp - Returns the time when the queue was last changed in seconds (epoch time).

• MaximumMessageSize - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

• MessageRetentionPeriod - Returns the number of seconds for which Amazon SQS retains a message.

• Policy - Returns the policy of the queue.

• QueueArn - Returns the Amazon resource name (ARN) of the queue.

• ReceiveMessageWaitTimeSeconds - Returns the number of seconds for which 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 the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

• VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

The following attributes apply only to FIFO (first-in-first-out) queues:

• FifoQueue - Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon SQS Developer Guide.

• ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

withAttributeNames

public GetQueueAttributesRequest withAttributeNames(java.lang.String... attributeNames)

A list of attributes for which to retrieve information.

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.

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.

• ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages that are waiting to be added to the queue.

• ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that have not timed-out and are not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

• CreatedTimestamp - Returns the time when the queue was created in seconds (epoch time).

• DelaySeconds - Returns the default delay on the queue in seconds.

• LastModifiedTimestamp - Returns the time when the queue was last changed in seconds (epoch time).

• MaximumMessageSize - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

• MessageRetentionPeriod - Returns the number of seconds for which Amazon SQS retains a message.

• Policy - Returns the policy of the queue.

• QueueArn - Returns the Amazon resource name (ARN) of the queue.

• ReceiveMessageWaitTimeSeconds - Returns the number of seconds for which 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 the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

• VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

The following attributes apply only to FIFO (first-in-first-out) queues:

• FifoQueue - Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon SQS Developer Guide.

• ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

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

Parameters:

attributeNames -

A list of attributes for which to retrieve information.

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.

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.

• ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages that are waiting to be added to the queue.

• ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that have not timed-out and are not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

• CreatedTimestamp - Returns the time when the queue was created in seconds (epoch time).

• DelaySeconds - Returns the default delay on the queue in seconds.

• LastModifiedTimestamp - Returns the time when the queue was last changed in seconds (epoch time).

• MaximumMessageSize - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

• MessageRetentionPeriod - Returns the number of seconds for which Amazon SQS retains a message.

• Policy - Returns the policy of the queue.

• QueueArn - Returns the Amazon resource name (ARN) of the queue.

• ReceiveMessageWaitTimeSeconds - Returns the number of seconds for which 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 the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

• VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

The following attributes apply only to FIFO (first-in-first-out) queues:

• FifoQueue - Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon SQS Developer Guide.

• ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

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

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.

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.

• ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages that are waiting to be added to the queue.

• ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that have not timed-out and are not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

• CreatedTimestamp - Returns the time when the queue was created in seconds (epoch time).

• DelaySeconds - Returns the default delay on the queue in seconds.

• LastModifiedTimestamp - Returns the time when the queue was last changed in seconds (epoch time).

• MaximumMessageSize - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

• MessageRetentionPeriod - Returns the number of seconds for which Amazon SQS retains a message.

• Policy - Returns the policy of the queue.

• QueueArn - Returns the Amazon resource name (ARN) of the queue.

• ReceiveMessageWaitTimeSeconds - Returns the number of seconds for which 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 the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

• VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

The following attributes apply only to FIFO (first-in-first-out) queues:

• FifoQueue - Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon SQS Developer Guide.

• ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

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

Parameters:

attributeNames -

A list of attributes for which to retrieve information.

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.

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.

• ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages that are waiting to be added to the queue.

• ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that have not timed-out and are not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

• CreatedTimestamp - Returns the time when the queue was created in seconds (epoch time).

• DelaySeconds - Returns the default delay on the queue in seconds.

• LastModifiedTimestamp - Returns the time when the queue was last changed in seconds (epoch time).

• MaximumMessageSize - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

• MessageRetentionPeriod - Returns the number of seconds for which Amazon SQS retains a message.

• Policy - Returns the policy of the queue.

• QueueArn - Returns the Amazon resource name (ARN) of the queue.

• ReceiveMessageWaitTimeSeconds - Returns the number of seconds for which 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 the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

• VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

The following attributes apply only to FIFO (first-in-first-out) queues:

• FifoQueue - Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon SQS Developer Guide.

• ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

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

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object