com.amazonaws.services.sqs.model

Class GetQueueAttributesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sqs.model.GetQueueAttributesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetQueueAttributesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
GetQueueAttributesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getAttributeNames() A list of attributes for which to retrieve information.
String	getQueueUrl() The URL of the Amazon SQS queue whose attribute information is retrieved.
int	hashCode()
void	setAttributeNames(Collection<String> attributeNames) A list of attributes for which to retrieve information.
void	setQueueUrl(String queueUrl) The URL of the Amazon SQS queue whose attribute information is retrieved.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetQueueAttributesRequest	withAttributeNames(Collection<String> attributeNames) A list of attributes for which to retrieve information.
GetQueueAttributesRequest	withAttributeNames(QueueAttributeName... attributeNames) A list of attributes for which to retrieve information.
GetQueueAttributesRequest	withAttributeNames(String... attributeNames) A list of attributes for which to retrieve information.
GetQueueAttributesRequest	withQueueUrl(String queueUrl) The URL of the Amazon SQS queue whose attribute information is retrieved.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

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 the 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 whose attribute information is retrieved.

Queue URLs are case-sensitive.

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 whose attribute information is retrieved.

Queue URLs are case-sensitive.

attributeNames - A list of attributes for which to retrieve information.

In the future, new attributes might be added. If you write 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 Simple Queue Service 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 aren't deleted. For more information, see Resources Required to Process Messages in the Amazon Simple Queue Service 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 length of time, in 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 length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.

• RedrivePolicy - Returns the string that includes 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 Simple Queue Service Developer Guide.

  • deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

  • maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue.

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

The following attributes apply only to server-side-encryption:

• KmsMasterKeyId - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.

• KmsDataKeyReusePeriodSeconds - Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?.

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 Simple Queue Service Developer Guide.

  To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

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

Method Detail

setQueueUrl

public void setQueueUrl(String queueUrl)

The URL of the Amazon SQS queue whose attribute information is retrieved.

Queue URLs are case-sensitive.

Parameters:

queueUrl - The URL of the Amazon SQS queue whose attribute information is retrieved.

Queue URLs are case-sensitive.

getQueueUrl

public String getQueueUrl()

The URL of the Amazon SQS queue whose attribute information is retrieved.

Queue URLs are case-sensitive.

Returns:

The URL of the Amazon SQS queue whose attribute information is retrieved.

Queue URLs are case-sensitive.

withQueueUrl

public GetQueueAttributesRequest withQueueUrl(String queueUrl)

The URL of the Amazon SQS queue whose attribute information is retrieved.

Queue URLs are case-sensitive.

Parameters:

queueUrl - The URL of the Amazon SQS queue whose attribute information is retrieved.

Queue URLs are case-sensitive.

Returns:

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

getAttributeNames

public List<String> getAttributeNames()

A list of attributes for which to retrieve information.

In the future, new attributes might be added. If you write 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 Simple Queue Service 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 aren't deleted. For more information, see Resources Required to Process Messages in the Amazon Simple Queue Service 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 length of time, in 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 length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.

• RedrivePolicy - Returns the string that includes 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 Simple Queue Service Developer Guide.

  • deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

  • maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue.

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

The following attributes apply only to server-side-encryption:

• KmsMasterKeyId - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.

• KmsDataKeyReusePeriodSeconds - Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?.

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 Simple Queue Service Developer Guide.

  To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

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

Returns:

A list of attributes for which to retrieve information.

In the future, new attributes might be added. If you write 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 Simple Queue Service 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 aren't deleted. For more information, see Resources Required to Process Messages in the Amazon Simple Queue Service 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 length of time, in 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 length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.

• RedrivePolicy - Returns the string that includes 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 Simple Queue Service Developer Guide.

  • deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

  • maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue.

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

The following attributes apply only to server-side-encryption:

• KmsMasterKeyId - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.

• KmsDataKeyReusePeriodSeconds - Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?.

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 Simple Queue Service Developer Guide.

  To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

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

See Also:

QueueAttributeName

setAttributeNames

public void setAttributeNames(Collection<String> attributeNames)

A list of attributes for which to retrieve information.

In the future, new attributes might be added. If you write 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 Simple Queue Service 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 aren't deleted. For more information, see Resources Required to Process Messages in the Amazon Simple Queue Service 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 length of time, in 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 length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.

• RedrivePolicy - Returns the string that includes 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 Simple Queue Service Developer Guide.

  • deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

  • maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue.

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

The following attributes apply only to server-side-encryption:

• KmsMasterKeyId - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.

• KmsDataKeyReusePeriodSeconds - Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?.

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 Simple Queue Service Developer Guide.

  To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

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

Parameters:

attributeNames - A list of attributes for which to retrieve information.

In the future, new attributes might be added. If you write 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 Simple Queue Service 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 aren't deleted. For more information, see Resources Required to Process Messages in the Amazon Simple Queue Service 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 length of time, in 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 length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.

• RedrivePolicy - Returns the string that includes 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 Simple Queue Service Developer Guide.

  • deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

  • maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue.

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

The following attributes apply only to server-side-encryption:

• KmsMasterKeyId - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.

• KmsDataKeyReusePeriodSeconds - Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?.

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 Simple Queue Service Developer Guide.

  To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

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

See Also:

QueueAttributeName

withAttributeNames

public GetQueueAttributesRequest withAttributeNames(String... attributeNames)

A list of attributes for which to retrieve information.

In the future, new attributes might be added. If you write 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 Simple Queue Service 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 aren't deleted. For more information, see Resources Required to Process Messages in the Amazon Simple Queue Service 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 length of time, in 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 length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.

• RedrivePolicy - Returns the string that includes 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 Simple Queue Service Developer Guide.

  • deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

  • maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue.

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

The following attributes apply only to server-side-encryption:

• KmsMasterKeyId - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.

• KmsDataKeyReusePeriodSeconds - Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?.

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 Simple Queue Service Developer Guide.

  To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

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

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.

Parameters:

attributeNames - A list of attributes for which to retrieve information.

In the future, new attributes might be added. If you write 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 Simple Queue Service 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 aren't deleted. For more information, see Resources Required to Process Messages in the Amazon Simple Queue Service 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 length of time, in 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 length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.

• RedrivePolicy - Returns the string that includes 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 Simple Queue Service Developer Guide.

  • deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

  • maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue.

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

The following attributes apply only to server-side-encryption:

• KmsMasterKeyId - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.

• KmsDataKeyReusePeriodSeconds - Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?.

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 Simple Queue Service Developer Guide.

  To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

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

Returns:

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

See Also:

QueueAttributeName

withAttributeNames

public GetQueueAttributesRequest withAttributeNames(Collection<String> attributeNames)

A list of attributes for which to retrieve information.

In the future, new attributes might be added. If you write 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 Simple Queue Service 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 aren't deleted. For more information, see Resources Required to Process Messages in the Amazon Simple Queue Service 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 length of time, in 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 length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.

• RedrivePolicy - Returns the string that includes 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 Simple Queue Service Developer Guide.

  • deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

  • maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue.

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

The following attributes apply only to server-side-encryption:

• KmsMasterKeyId - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.

• KmsDataKeyReusePeriodSeconds - Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?.

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 Simple Queue Service Developer Guide.

  To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

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

Parameters:

attributeNames - A list of attributes for which to retrieve information.

In the future, new attributes might be added. If you write 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 Simple Queue Service 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 aren't deleted. For more information, see Resources Required to Process Messages in the Amazon Simple Queue Service 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 length of time, in 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 length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.

• RedrivePolicy - Returns the string that includes 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 Simple Queue Service Developer Guide.

  • deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

  • maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue.

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

The following attributes apply only to server-side-encryption:

• KmsMasterKeyId - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.

• KmsDataKeyReusePeriodSeconds - Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?.

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 Simple Queue Service Developer Guide.

  To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

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

Returns:

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

See Also:

QueueAttributeName

withAttributeNames

public GetQueueAttributesRequest withAttributeNames(QueueAttributeName... attributeNames)

A list of attributes for which to retrieve information.

In the future, new attributes might be added. If you write 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 Simple Queue Service 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 aren't deleted. For more information, see Resources Required to Process Messages in the Amazon Simple Queue Service 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 length of time, in 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 length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.

• RedrivePolicy - Returns the string that includes 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 Simple Queue Service Developer Guide.

  • deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

  • maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue.

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

The following attributes apply only to server-side-encryption:

• KmsMasterKeyId - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.

• KmsDataKeyReusePeriodSeconds - Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?.

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 Simple Queue Service Developer Guide.

  To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

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

Parameters:

attributeNames - A list of attributes for which to retrieve information.

In the future, new attributes might be added. If you write 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 Simple Queue Service 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 aren't deleted. For more information, see Resources Required to Process Messages in the Amazon Simple Queue Service 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 length of time, in 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 length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.

• RedrivePolicy - Returns the string that includes 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 Simple Queue Service Developer Guide.

  • deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

  • maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue.

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

The following attributes apply only to server-side-encryption:

• KmsMasterKeyId - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.

• KmsDataKeyReusePeriodSeconds - Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?.

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 Simple Queue Service Developer Guide.

  To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

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

Returns:

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

See Also:

QueueAttributeName

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetQueueAttributesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()