/* * Copyright 2012-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.sqs.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * <p/> * * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueAttributes" target="_top">AWS API * Documentation</a> */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class GetQueueAttributesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** * <p> * The URL of the Amazon SQS queue whose attribute information is retrieved. * </p> * <p> * Queue URLs are case-sensitive. * </p> */ private String queueUrl; /** * <p> * A list of attributes for which to retrieve information. * </p> * <note> * <p> * 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. * </p> * </note> * <p> * The following attributes are supported: * </p> * <ul> * <li> * <p> * <code>All</code> - Returns all values. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessages</code> - Returns the approximate number of visible messages in a queue. For * more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesDelayed</code> - Returns the approximate number of messages that are waiting to * be added to the queue. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesNotVisible</code> - Returns the approximate number of messages that have not * timed-out and aren't deleted. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>CreatedTimestamp</code> - Returns the time when the queue was created in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>DelaySeconds</code> - Returns the default delay on the queue in seconds. * </p> * </li> * <li> * <p> * <code>LastModifiedTimestamp</code> - Returns the time when the queue was last changed in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>MaximumMessageSize</code> - Returns the limit of how many bytes a message can contain before Amazon SQS * rejects it. * </p> * </li> * <li> * <p> * <code>MessageRetentionPeriod</code> - Returns the length of time, in seconds, for which Amazon SQS retains a * message. * </p> * </li> * <li> * <p> * <code>Policy</code> - Returns the policy of the queue. * </p> * </li> * <li> * <p> * <code>QueueArn</code> - Returns the Amazon resource name (ARN) of the queue. * </p> * </li> * <li> * <p> * <code>ReceiveMessageWaitTimeSeconds</code> - Returns the length of time, in seconds, for which the * <code>ReceiveMessage</code> action waits for a message to arrive. * </p> * </li> * <li> * <p> * <code>RedrivePolicy</code> - Returns the parameters for dead letter queue functionality of the source queue. For * more information about the redrive policy and dead letter queues, see <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html" * >Using Amazon SQS Dead Letter Queues</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>VisibilityTimeout</code> - Returns the visibility timeout for the queue. For more information about the * visibility timeout, see <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html" * >Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html" * >server-side-encryption</a>: * </p> * <ul> * <li> * <p> * <code>KmsMasterKeyId</code> - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a * custom CMK. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms" * >Key Terms</a>. * </p> * </li> * <li> * <p> * <code>KmsDataKeyReusePeriodSeconds</code> - 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. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO * (first-in-first-out) queues</a>: * </p> * <ul> * <li> * <p> * <code>FifoQueue</code> - Returns whether the queue is FIFO. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic" * >FIFO Queue Logic</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * <note> * <p> * To determine whether a queue is <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO</a>, you * can check whether <code>QueueName</code> ends with the <code>.fifo</code> suffix. * </p> * </note></li> * <li> * <p> * <code>ContentBasedDeduplication</code> - Returns whether content-based deduplication is enabled for the queue. * For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing" * >Exactly-Once Processing</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * </ul> */ private com.amazonaws.internal.SdkInternalList<String> attributeNames; /** * Default constructor for GetQueueAttributesRequest object. Callers should use the setter or fluent setter * (with...) methods to initialize the object after creating it. */ public GetQueueAttributesRequest() { } /** * Constructs a new GetQueueAttributesRequest object. Callers should use the setter or fluent setter (with...) * methods to initialize any additional object members. * * @param queueUrl * The URL of the Amazon SQS queue whose attribute information is retrieved.</p> * <p> * Queue URLs are case-sensitive. */ public GetQueueAttributesRequest(String queueUrl) { setQueueUrl(queueUrl); } /** * Constructs a new GetQueueAttributesRequest object. Callers should use the setter or fluent setter (with...) * methods to initialize any additional object members. * * @param queueUrl * The URL of the Amazon SQS queue whose attribute information is retrieved.</p> * <p> * Queue URLs are case-sensitive. * @param attributeNames * A list of attributes for which to retrieve information. * </p> * <note> * <p> * 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. * </p> * </note> * <p> * The following attributes are supported: * </p> * <ul> * <li> * <p> * <code>All</code> - Returns all values. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessages</code> - Returns the approximate number of visible messages in a queue. * For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesDelayed</code> - Returns the approximate number of messages that are * waiting to be added to the queue. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesNotVisible</code> - Returns the approximate number of messages that have * not timed-out and aren't deleted. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>CreatedTimestamp</code> - Returns the time when the queue was created in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>DelaySeconds</code> - Returns the default delay on the queue in seconds. * </p> * </li> * <li> * <p> * <code>LastModifiedTimestamp</code> - Returns the time when the queue was last changed in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>MaximumMessageSize</code> - Returns the limit of how many bytes a message can contain before Amazon * SQS rejects it. * </p> * </li> * <li> * <p> * <code>MessageRetentionPeriod</code> - Returns the length of time, in seconds, for which Amazon SQS retains * a message. * </p> * </li> * <li> * <p> * <code>Policy</code> - Returns the policy of the queue. * </p> * </li> * <li> * <p> * <code>QueueArn</code> - Returns the Amazon resource name (ARN) of the queue. * </p> * </li> * <li> * <p> * <code>ReceiveMessageWaitTimeSeconds</code> - Returns the length of time, in seconds, for which the * <code>ReceiveMessage</code> action waits for a message to arrive. * </p> * </li> * <li> * <p> * <code>RedrivePolicy</code> - Returns the parameters for dead letter queue functionality of the source * queue. For more information about the redrive policy and dead letter queues, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html" * >Using Amazon SQS Dead Letter Queues</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>VisibilityTimeout</code> - Returns the visibility timeout for the queue. For more information about * the visibility timeout, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html" * >Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html" * >server-side-encryption</a>: * </p> * <ul> * <li> * <p> * <code>KmsMasterKeyId</code> - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or * a custom CMK. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms" * >Key Terms</a>. * </p> * </li> * <li> * <p> * <code>KmsDataKeyReusePeriodSeconds</code> - 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. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO * (first-in-first-out) queues</a>: * </p> * <ul> * <li> * <p> * <code>FifoQueue</code> - Returns whether the queue is FIFO. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic" * >FIFO Queue Logic</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * <note> * <p> * To determine whether a queue is <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html" * >FIFO</a>, you can check whether <code>QueueName</code> ends with the <code>.fifo</code> suffix. * </p> * </note></li> * <li> * <p> * <code>ContentBasedDeduplication</code> - Returns whether content-based deduplication is enabled for the * queue. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing" * >Exactly-Once Processing</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> */ public GetQueueAttributesRequest(String queueUrl, java.util.List<String> attributeNames) { setQueueUrl(queueUrl); setAttributeNames(attributeNames); } /** * <p> * The URL of the Amazon SQS queue whose attribute information is retrieved. * </p> * <p> * Queue URLs are case-sensitive. * </p> * * @param queueUrl * The URL of the Amazon SQS queue whose attribute information is retrieved.</p> * <p> * Queue URLs are case-sensitive. */ public void setQueueUrl(String queueUrl) { this.queueUrl = queueUrl; } /** * <p> * The URL of the Amazon SQS queue whose attribute information is retrieved. * </p> * <p> * Queue URLs are case-sensitive. * </p> * * @return The URL of the Amazon SQS queue whose attribute information is retrieved.</p> * <p> * Queue URLs are case-sensitive. */ public String getQueueUrl() { return this.queueUrl; } /** * <p> * The URL of the Amazon SQS queue whose attribute information is retrieved. * </p> * <p> * Queue URLs are case-sensitive. * </p> * * @param queueUrl * The URL of the Amazon SQS queue whose attribute information is retrieved.</p> * <p> * Queue URLs are case-sensitive. * @return Returns a reference to this object so that method calls can be chained together. */ public GetQueueAttributesRequest withQueueUrl(String queueUrl) { setQueueUrl(queueUrl); return this; } /** * <p> * A list of attributes for which to retrieve information. * </p> * <note> * <p> * 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. * </p> * </note> * <p> * The following attributes are supported: * </p> * <ul> * <li> * <p> * <code>All</code> - Returns all values. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessages</code> - Returns the approximate number of visible messages in a queue. For * more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesDelayed</code> - Returns the approximate number of messages that are waiting to * be added to the queue. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesNotVisible</code> - Returns the approximate number of messages that have not * timed-out and aren't deleted. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>CreatedTimestamp</code> - Returns the time when the queue was created in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>DelaySeconds</code> - Returns the default delay on the queue in seconds. * </p> * </li> * <li> * <p> * <code>LastModifiedTimestamp</code> - Returns the time when the queue was last changed in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>MaximumMessageSize</code> - Returns the limit of how many bytes a message can contain before Amazon SQS * rejects it. * </p> * </li> * <li> * <p> * <code>MessageRetentionPeriod</code> - Returns the length of time, in seconds, for which Amazon SQS retains a * message. * </p> * </li> * <li> * <p> * <code>Policy</code> - Returns the policy of the queue. * </p> * </li> * <li> * <p> * <code>QueueArn</code> - Returns the Amazon resource name (ARN) of the queue. * </p> * </li> * <li> * <p> * <code>ReceiveMessageWaitTimeSeconds</code> - Returns the length of time, in seconds, for which the * <code>ReceiveMessage</code> action waits for a message to arrive. * </p> * </li> * <li> * <p> * <code>RedrivePolicy</code> - Returns the parameters for dead letter queue functionality of the source queue. For * more information about the redrive policy and dead letter queues, see <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html" * >Using Amazon SQS Dead Letter Queues</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>VisibilityTimeout</code> - Returns the visibility timeout for the queue. For more information about the * visibility timeout, see <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html" * >Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html" * >server-side-encryption</a>: * </p> * <ul> * <li> * <p> * <code>KmsMasterKeyId</code> - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a * custom CMK. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms" * >Key Terms</a>. * </p> * </li> * <li> * <p> * <code>KmsDataKeyReusePeriodSeconds</code> - 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. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO * (first-in-first-out) queues</a>: * </p> * <ul> * <li> * <p> * <code>FifoQueue</code> - Returns whether the queue is FIFO. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic" * >FIFO Queue Logic</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * <note> * <p> * To determine whether a queue is <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO</a>, you * can check whether <code>QueueName</code> ends with the <code>.fifo</code> suffix. * </p> * </note></li> * <li> * <p> * <code>ContentBasedDeduplication</code> - Returns whether content-based deduplication is enabled for the queue. * For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing" * >Exactly-Once Processing</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * </ul> * * @return A list of attributes for which to retrieve information.</p> <note> * <p> * 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. * </p> * </note> * <p> * The following attributes are supported: * </p> * <ul> * <li> * <p> * <code>All</code> - Returns all values. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessages</code> - Returns the approximate number of visible messages in a queue. * For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesDelayed</code> - Returns the approximate number of messages that are * waiting to be added to the queue. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesNotVisible</code> - Returns the approximate number of messages that have * not timed-out and aren't deleted. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>CreatedTimestamp</code> - Returns the time when the queue was created in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>DelaySeconds</code> - Returns the default delay on the queue in seconds. * </p> * </li> * <li> * <p> * <code>LastModifiedTimestamp</code> - Returns the time when the queue was last changed in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>MaximumMessageSize</code> - Returns the limit of how many bytes a message can contain before Amazon * SQS rejects it. * </p> * </li> * <li> * <p> * <code>MessageRetentionPeriod</code> - Returns the length of time, in seconds, for which Amazon SQS * retains a message. * </p> * </li> * <li> * <p> * <code>Policy</code> - Returns the policy of the queue. * </p> * </li> * <li> * <p> * <code>QueueArn</code> - Returns the Amazon resource name (ARN) of the queue. * </p> * </li> * <li> * <p> * <code>ReceiveMessageWaitTimeSeconds</code> - Returns the length of time, in seconds, for which the * <code>ReceiveMessage</code> action waits for a message to arrive. * </p> * </li> * <li> * <p> * <code>RedrivePolicy</code> - Returns the parameters for dead letter queue functionality of the source * queue. For more information about the redrive policy and dead letter queues, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html" * >Using Amazon SQS Dead Letter Queues</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>VisibilityTimeout</code> - Returns the visibility timeout for the queue. For more information about * the visibility timeout, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html" * >Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html" * >server-side-encryption</a>: * </p> * <ul> * <li> * <p> * <code>KmsMasterKeyId</code> - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS * or a custom CMK. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms" * >Key Terms</a>. * </p> * </li> * <li> * <p> * <code>KmsDataKeyReusePeriodSeconds</code> - 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. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO * (first-in-first-out) queues</a>: * </p> * <ul> * <li> * <p> * <code>FifoQueue</code> - Returns whether the queue is FIFO. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic" * >FIFO Queue Logic</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * <note> * <p> * To determine whether a queue is <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html" * >FIFO</a>, you can check whether <code>QueueName</code> ends with the <code>.fifo</code> suffix. * </p> * </note></li> * <li> * <p> * <code>ContentBasedDeduplication</code> - Returns whether content-based deduplication is enabled for the * queue. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing" * >Exactly-Once Processing</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * @see QueueAttributeName */ public java.util.List<String> getAttributeNames() { if (attributeNames == null) { attributeNames = new com.amazonaws.internal.SdkInternalList<String>(); } return attributeNames; } /** * <p> * A list of attributes for which to retrieve information. * </p> * <note> * <p> * 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. * </p> * </note> * <p> * The following attributes are supported: * </p> * <ul> * <li> * <p> * <code>All</code> - Returns all values. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessages</code> - Returns the approximate number of visible messages in a queue. For * more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesDelayed</code> - Returns the approximate number of messages that are waiting to * be added to the queue. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesNotVisible</code> - Returns the approximate number of messages that have not * timed-out and aren't deleted. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>CreatedTimestamp</code> - Returns the time when the queue was created in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>DelaySeconds</code> - Returns the default delay on the queue in seconds. * </p> * </li> * <li> * <p> * <code>LastModifiedTimestamp</code> - Returns the time when the queue was last changed in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>MaximumMessageSize</code> - Returns the limit of how many bytes a message can contain before Amazon SQS * rejects it. * </p> * </li> * <li> * <p> * <code>MessageRetentionPeriod</code> - Returns the length of time, in seconds, for which Amazon SQS retains a * message. * </p> * </li> * <li> * <p> * <code>Policy</code> - Returns the policy of the queue. * </p> * </li> * <li> * <p> * <code>QueueArn</code> - Returns the Amazon resource name (ARN) of the queue. * </p> * </li> * <li> * <p> * <code>ReceiveMessageWaitTimeSeconds</code> - Returns the length of time, in seconds, for which the * <code>ReceiveMessage</code> action waits for a message to arrive. * </p> * </li> * <li> * <p> * <code>RedrivePolicy</code> - Returns the parameters for dead letter queue functionality of the source queue. For * more information about the redrive policy and dead letter queues, see <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html" * >Using Amazon SQS Dead Letter Queues</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>VisibilityTimeout</code> - Returns the visibility timeout for the queue. For more information about the * visibility timeout, see <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html" * >Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html" * >server-side-encryption</a>: * </p> * <ul> * <li> * <p> * <code>KmsMasterKeyId</code> - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a * custom CMK. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms" * >Key Terms</a>. * </p> * </li> * <li> * <p> * <code>KmsDataKeyReusePeriodSeconds</code> - 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. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO * (first-in-first-out) queues</a>: * </p> * <ul> * <li> * <p> * <code>FifoQueue</code> - Returns whether the queue is FIFO. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic" * >FIFO Queue Logic</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * <note> * <p> * To determine whether a queue is <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO</a>, you * can check whether <code>QueueName</code> ends with the <code>.fifo</code> suffix. * </p> * </note></li> * <li> * <p> * <code>ContentBasedDeduplication</code> - Returns whether content-based deduplication is enabled for the queue. * For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing" * >Exactly-Once Processing</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * </ul> * * @param attributeNames * A list of attributes for which to retrieve information.</p> <note> * <p> * 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. * </p> * </note> * <p> * The following attributes are supported: * </p> * <ul> * <li> * <p> * <code>All</code> - Returns all values. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessages</code> - Returns the approximate number of visible messages in a queue. * For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesDelayed</code> - Returns the approximate number of messages that are * waiting to be added to the queue. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesNotVisible</code> - Returns the approximate number of messages that have * not timed-out and aren't deleted. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>CreatedTimestamp</code> - Returns the time when the queue was created in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>DelaySeconds</code> - Returns the default delay on the queue in seconds. * </p> * </li> * <li> * <p> * <code>LastModifiedTimestamp</code> - Returns the time when the queue was last changed in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>MaximumMessageSize</code> - Returns the limit of how many bytes a message can contain before Amazon * SQS rejects it. * </p> * </li> * <li> * <p> * <code>MessageRetentionPeriod</code> - Returns the length of time, in seconds, for which Amazon SQS retains * a message. * </p> * </li> * <li> * <p> * <code>Policy</code> - Returns the policy of the queue. * </p> * </li> * <li> * <p> * <code>QueueArn</code> - Returns the Amazon resource name (ARN) of the queue. * </p> * </li> * <li> * <p> * <code>ReceiveMessageWaitTimeSeconds</code> - Returns the length of time, in seconds, for which the * <code>ReceiveMessage</code> action waits for a message to arrive. * </p> * </li> * <li> * <p> * <code>RedrivePolicy</code> - Returns the parameters for dead letter queue functionality of the source * queue. For more information about the redrive policy and dead letter queues, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html" * >Using Amazon SQS Dead Letter Queues</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>VisibilityTimeout</code> - Returns the visibility timeout for the queue. For more information about * the visibility timeout, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html" * >Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html" * >server-side-encryption</a>: * </p> * <ul> * <li> * <p> * <code>KmsMasterKeyId</code> - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or * a custom CMK. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms" * >Key Terms</a>. * </p> * </li> * <li> * <p> * <code>KmsDataKeyReusePeriodSeconds</code> - 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. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO * (first-in-first-out) queues</a>: * </p> * <ul> * <li> * <p> * <code>FifoQueue</code> - Returns whether the queue is FIFO. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic" * >FIFO Queue Logic</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * <note> * <p> * To determine whether a queue is <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html" * >FIFO</a>, you can check whether <code>QueueName</code> ends with the <code>.fifo</code> suffix. * </p> * </note></li> * <li> * <p> * <code>ContentBasedDeduplication</code> - Returns whether content-based deduplication is enabled for the * queue. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing" * >Exactly-Once Processing</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * @see QueueAttributeName */ public void setAttributeNames(java.util.Collection<String> attributeNames) { if (attributeNames == null) { this.attributeNames = null; return; } this.attributeNames = new com.amazonaws.internal.SdkInternalList<String>(attributeNames); } /** * <p> * A list of attributes for which to retrieve information. * </p> * <note> * <p> * 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. * </p> * </note> * <p> * The following attributes are supported: * </p> * <ul> * <li> * <p> * <code>All</code> - Returns all values. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessages</code> - Returns the approximate number of visible messages in a queue. For * more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesDelayed</code> - Returns the approximate number of messages that are waiting to * be added to the queue. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesNotVisible</code> - Returns the approximate number of messages that have not * timed-out and aren't deleted. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>CreatedTimestamp</code> - Returns the time when the queue was created in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>DelaySeconds</code> - Returns the default delay on the queue in seconds. * </p> * </li> * <li> * <p> * <code>LastModifiedTimestamp</code> - Returns the time when the queue was last changed in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>MaximumMessageSize</code> - Returns the limit of how many bytes a message can contain before Amazon SQS * rejects it. * </p> * </li> * <li> * <p> * <code>MessageRetentionPeriod</code> - Returns the length of time, in seconds, for which Amazon SQS retains a * message. * </p> * </li> * <li> * <p> * <code>Policy</code> - Returns the policy of the queue. * </p> * </li> * <li> * <p> * <code>QueueArn</code> - Returns the Amazon resource name (ARN) of the queue. * </p> * </li> * <li> * <p> * <code>ReceiveMessageWaitTimeSeconds</code> - Returns the length of time, in seconds, for which the * <code>ReceiveMessage</code> action waits for a message to arrive. * </p> * </li> * <li> * <p> * <code>RedrivePolicy</code> - Returns the parameters for dead letter queue functionality of the source queue. For * more information about the redrive policy and dead letter queues, see <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html" * >Using Amazon SQS Dead Letter Queues</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>VisibilityTimeout</code> - Returns the visibility timeout for the queue. For more information about the * visibility timeout, see <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html" * >Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html" * >server-side-encryption</a>: * </p> * <ul> * <li> * <p> * <code>KmsMasterKeyId</code> - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a * custom CMK. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms" * >Key Terms</a>. * </p> * </li> * <li> * <p> * <code>KmsDataKeyReusePeriodSeconds</code> - 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. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO * (first-in-first-out) queues</a>: * </p> * <ul> * <li> * <p> * <code>FifoQueue</code> - Returns whether the queue is FIFO. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic" * >FIFO Queue Logic</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * <note> * <p> * To determine whether a queue is <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO</a>, you * can check whether <code>QueueName</code> ends with the <code>.fifo</code> suffix. * </p> * </note></li> * <li> * <p> * <code>ContentBasedDeduplication</code> - Returns whether content-based deduplication is enabled for the queue. * For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing" * >Exactly-Once Processing</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * </ul> * <p> * <b>NOTE:</b> This method appends the values to the existing list (if any). Use * {@link #setAttributeNames(java.util.Collection)} or {@link #withAttributeNames(java.util.Collection)} if you want * to override the existing values. * </p> * * @param attributeNames * A list of attributes for which to retrieve information.</p> <note> * <p> * 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. * </p> * </note> * <p> * The following attributes are supported: * </p> * <ul> * <li> * <p> * <code>All</code> - Returns all values. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessages</code> - Returns the approximate number of visible messages in a queue. * For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesDelayed</code> - Returns the approximate number of messages that are * waiting to be added to the queue. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesNotVisible</code> - Returns the approximate number of messages that have * not timed-out and aren't deleted. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>CreatedTimestamp</code> - Returns the time when the queue was created in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>DelaySeconds</code> - Returns the default delay on the queue in seconds. * </p> * </li> * <li> * <p> * <code>LastModifiedTimestamp</code> - Returns the time when the queue was last changed in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>MaximumMessageSize</code> - Returns the limit of how many bytes a message can contain before Amazon * SQS rejects it. * </p> * </li> * <li> * <p> * <code>MessageRetentionPeriod</code> - Returns the length of time, in seconds, for which Amazon SQS retains * a message. * </p> * </li> * <li> * <p> * <code>Policy</code> - Returns the policy of the queue. * </p> * </li> * <li> * <p> * <code>QueueArn</code> - Returns the Amazon resource name (ARN) of the queue. * </p> * </li> * <li> * <p> * <code>ReceiveMessageWaitTimeSeconds</code> - Returns the length of time, in seconds, for which the * <code>ReceiveMessage</code> action waits for a message to arrive. * </p> * </li> * <li> * <p> * <code>RedrivePolicy</code> - Returns the parameters for dead letter queue functionality of the source * queue. For more information about the redrive policy and dead letter queues, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html" * >Using Amazon SQS Dead Letter Queues</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>VisibilityTimeout</code> - Returns the visibility timeout for the queue. For more information about * the visibility timeout, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html" * >Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html" * >server-side-encryption</a>: * </p> * <ul> * <li> * <p> * <code>KmsMasterKeyId</code> - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or * a custom CMK. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms" * >Key Terms</a>. * </p> * </li> * <li> * <p> * <code>KmsDataKeyReusePeriodSeconds</code> - 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. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO * (first-in-first-out) queues</a>: * </p> * <ul> * <li> * <p> * <code>FifoQueue</code> - Returns whether the queue is FIFO. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic" * >FIFO Queue Logic</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * <note> * <p> * To determine whether a queue is <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html" * >FIFO</a>, you can check whether <code>QueueName</code> ends with the <code>.fifo</code> suffix. * </p> * </note></li> * <li> * <p> * <code>ContentBasedDeduplication</code> - Returns whether content-based deduplication is enabled for the * queue. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing" * >Exactly-Once Processing</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * @return Returns a reference to this object so that method calls can be chained together. * @see QueueAttributeName */ public GetQueueAttributesRequest withAttributeNames(String... attributeNames) { if (this.attributeNames == null) { setAttributeNames(new com.amazonaws.internal.SdkInternalList<String>(attributeNames.length)); } for (String ele : attributeNames) { this.attributeNames.add(ele); } return this; } /** * <p> * A list of attributes for which to retrieve information. * </p> * <note> * <p> * 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. * </p> * </note> * <p> * The following attributes are supported: * </p> * <ul> * <li> * <p> * <code>All</code> - Returns all values. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessages</code> - Returns the approximate number of visible messages in a queue. For * more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesDelayed</code> - Returns the approximate number of messages that are waiting to * be added to the queue. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesNotVisible</code> - Returns the approximate number of messages that have not * timed-out and aren't deleted. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>CreatedTimestamp</code> - Returns the time when the queue was created in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>DelaySeconds</code> - Returns the default delay on the queue in seconds. * </p> * </li> * <li> * <p> * <code>LastModifiedTimestamp</code> - Returns the time when the queue was last changed in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>MaximumMessageSize</code> - Returns the limit of how many bytes a message can contain before Amazon SQS * rejects it. * </p> * </li> * <li> * <p> * <code>MessageRetentionPeriod</code> - Returns the length of time, in seconds, for which Amazon SQS retains a * message. * </p> * </li> * <li> * <p> * <code>Policy</code> - Returns the policy of the queue. * </p> * </li> * <li> * <p> * <code>QueueArn</code> - Returns the Amazon resource name (ARN) of the queue. * </p> * </li> * <li> * <p> * <code>ReceiveMessageWaitTimeSeconds</code> - Returns the length of time, in seconds, for which the * <code>ReceiveMessage</code> action waits for a message to arrive. * </p> * </li> * <li> * <p> * <code>RedrivePolicy</code> - Returns the parameters for dead letter queue functionality of the source queue. For * more information about the redrive policy and dead letter queues, see <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html" * >Using Amazon SQS Dead Letter Queues</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>VisibilityTimeout</code> - Returns the visibility timeout for the queue. For more information about the * visibility timeout, see <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html" * >Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html" * >server-side-encryption</a>: * </p> * <ul> * <li> * <p> * <code>KmsMasterKeyId</code> - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a * custom CMK. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms" * >Key Terms</a>. * </p> * </li> * <li> * <p> * <code>KmsDataKeyReusePeriodSeconds</code> - 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. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO * (first-in-first-out) queues</a>: * </p> * <ul> * <li> * <p> * <code>FifoQueue</code> - Returns whether the queue is FIFO. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic" * >FIFO Queue Logic</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * <note> * <p> * To determine whether a queue is <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO</a>, you * can check whether <code>QueueName</code> ends with the <code>.fifo</code> suffix. * </p> * </note></li> * <li> * <p> * <code>ContentBasedDeduplication</code> - Returns whether content-based deduplication is enabled for the queue. * For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing" * >Exactly-Once Processing</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * </ul> * * @param attributeNames * A list of attributes for which to retrieve information.</p> <note> * <p> * 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. * </p> * </note> * <p> * The following attributes are supported: * </p> * <ul> * <li> * <p> * <code>All</code> - Returns all values. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessages</code> - Returns the approximate number of visible messages in a queue. * For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesDelayed</code> - Returns the approximate number of messages that are * waiting to be added to the queue. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesNotVisible</code> - Returns the approximate number of messages that have * not timed-out and aren't deleted. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>CreatedTimestamp</code> - Returns the time when the queue was created in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>DelaySeconds</code> - Returns the default delay on the queue in seconds. * </p> * </li> * <li> * <p> * <code>LastModifiedTimestamp</code> - Returns the time when the queue was last changed in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>MaximumMessageSize</code> - Returns the limit of how many bytes a message can contain before Amazon * SQS rejects it. * </p> * </li> * <li> * <p> * <code>MessageRetentionPeriod</code> - Returns the length of time, in seconds, for which Amazon SQS retains * a message. * </p> * </li> * <li> * <p> * <code>Policy</code> - Returns the policy of the queue. * </p> * </li> * <li> * <p> * <code>QueueArn</code> - Returns the Amazon resource name (ARN) of the queue. * </p> * </li> * <li> * <p> * <code>ReceiveMessageWaitTimeSeconds</code> - Returns the length of time, in seconds, for which the * <code>ReceiveMessage</code> action waits for a message to arrive. * </p> * </li> * <li> * <p> * <code>RedrivePolicy</code> - Returns the parameters for dead letter queue functionality of the source * queue. For more information about the redrive policy and dead letter queues, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html" * >Using Amazon SQS Dead Letter Queues</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>VisibilityTimeout</code> - Returns the visibility timeout for the queue. For more information about * the visibility timeout, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html" * >Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html" * >server-side-encryption</a>: * </p> * <ul> * <li> * <p> * <code>KmsMasterKeyId</code> - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or * a custom CMK. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms" * >Key Terms</a>. * </p> * </li> * <li> * <p> * <code>KmsDataKeyReusePeriodSeconds</code> - 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. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO * (first-in-first-out) queues</a>: * </p> * <ul> * <li> * <p> * <code>FifoQueue</code> - Returns whether the queue is FIFO. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic" * >FIFO Queue Logic</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * <note> * <p> * To determine whether a queue is <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html" * >FIFO</a>, you can check whether <code>QueueName</code> ends with the <code>.fifo</code> suffix. * </p> * </note></li> * <li> * <p> * <code>ContentBasedDeduplication</code> - Returns whether content-based deduplication is enabled for the * queue. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing" * >Exactly-Once Processing</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * @return Returns a reference to this object so that method calls can be chained together. * @see QueueAttributeName */ public GetQueueAttributesRequest withAttributeNames(java.util.Collection<String> attributeNames) { setAttributeNames(attributeNames); return this; } /** * <p> * A list of attributes for which to retrieve information. * </p> * <note> * <p> * 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. * </p> * </note> * <p> * The following attributes are supported: * </p> * <ul> * <li> * <p> * <code>All</code> - Returns all values. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessages</code> - Returns the approximate number of visible messages in a queue. For * more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesDelayed</code> - Returns the approximate number of messages that are waiting to * be added to the queue. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesNotVisible</code> - Returns the approximate number of messages that have not * timed-out and aren't deleted. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>CreatedTimestamp</code> - Returns the time when the queue was created in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>DelaySeconds</code> - Returns the default delay on the queue in seconds. * </p> * </li> * <li> * <p> * <code>LastModifiedTimestamp</code> - Returns the time when the queue was last changed in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>MaximumMessageSize</code> - Returns the limit of how many bytes a message can contain before Amazon SQS * rejects it. * </p> * </li> * <li> * <p> * <code>MessageRetentionPeriod</code> - Returns the length of time, in seconds, for which Amazon SQS retains a * message. * </p> * </li> * <li> * <p> * <code>Policy</code> - Returns the policy of the queue. * </p> * </li> * <li> * <p> * <code>QueueArn</code> - Returns the Amazon resource name (ARN) of the queue. * </p> * </li> * <li> * <p> * <code>ReceiveMessageWaitTimeSeconds</code> - Returns the length of time, in seconds, for which the * <code>ReceiveMessage</code> action waits for a message to arrive. * </p> * </li> * <li> * <p> * <code>RedrivePolicy</code> - Returns the parameters for dead letter queue functionality of the source queue. For * more information about the redrive policy and dead letter queues, see <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html" * >Using Amazon SQS Dead Letter Queues</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>VisibilityTimeout</code> - Returns the visibility timeout for the queue. For more information about the * visibility timeout, see <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html" * >Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html" * >server-side-encryption</a>: * </p> * <ul> * <li> * <p> * <code>KmsMasterKeyId</code> - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a * custom CMK. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms" * >Key Terms</a>. * </p> * </li> * <li> * <p> * <code>KmsDataKeyReusePeriodSeconds</code> - 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. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO * (first-in-first-out) queues</a>: * </p> * <ul> * <li> * <p> * <code>FifoQueue</code> - Returns whether the queue is FIFO. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic" * >FIFO Queue Logic</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * <note> * <p> * To determine whether a queue is <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO</a>, you * can check whether <code>QueueName</code> ends with the <code>.fifo</code> suffix. * </p> * </note></li> * <li> * <p> * <code>ContentBasedDeduplication</code> - Returns whether content-based deduplication is enabled for the queue. * For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing" * >Exactly-Once Processing</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * </ul> * * @param attributeNames * A list of attributes for which to retrieve information.</p> <note> * <p> * 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. * </p> * </note> * <p> * The following attributes are supported: * </p> * <ul> * <li> * <p> * <code>All</code> - Returns all values. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessages</code> - Returns the approximate number of visible messages in a queue. * For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesDelayed</code> - Returns the approximate number of messages that are * waiting to be added to the queue. * </p> * </li> * <li> * <p> * <code>ApproximateNumberOfMessagesNotVisible</code> - Returns the approximate number of messages that have * not timed-out and aren't deleted. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html" * >Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>CreatedTimestamp</code> - Returns the time when the queue was created in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>DelaySeconds</code> - Returns the default delay on the queue in seconds. * </p> * </li> * <li> * <p> * <code>LastModifiedTimestamp</code> - Returns the time when the queue was last changed in seconds (<a * href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). * </p> * </li> * <li> * <p> * <code>MaximumMessageSize</code> - Returns the limit of how many bytes a message can contain before Amazon * SQS rejects it. * </p> * </li> * <li> * <p> * <code>MessageRetentionPeriod</code> - Returns the length of time, in seconds, for which Amazon SQS retains * a message. * </p> * </li> * <li> * <p> * <code>Policy</code> - Returns the policy of the queue. * </p> * </li> * <li> * <p> * <code>QueueArn</code> - Returns the Amazon resource name (ARN) of the queue. * </p> * </li> * <li> * <p> * <code>ReceiveMessageWaitTimeSeconds</code> - Returns the length of time, in seconds, for which the * <code>ReceiveMessage</code> action waits for a message to arrive. * </p> * </li> * <li> * <p> * <code>RedrivePolicy</code> - Returns the parameters for dead letter queue functionality of the source * queue. For more information about the redrive policy and dead letter queues, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html" * >Using Amazon SQS Dead Letter Queues</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * <li> * <p> * <code>VisibilityTimeout</code> - Returns the visibility timeout for the queue. For more information about * the visibility timeout, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html" * >Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html" * >server-side-encryption</a>: * </p> * <ul> * <li> * <p> * <code>KmsMasterKeyId</code> - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or * a custom CMK. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms" * >Key Terms</a>. * </p> * </li> * <li> * <p> * <code>KmsDataKeyReusePeriodSeconds</code> - 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. * </p> * </li> * </ul> * <p> * The following attributes apply only to <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO * (first-in-first-out) queues</a>: * </p> * <ul> * <li> * <p> * <code>FifoQueue</code> - Returns whether the queue is FIFO. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic" * >FIFO Queue Logic</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * <note> * <p> * To determine whether a queue is <a * href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html" * >FIFO</a>, you can check whether <code>QueueName</code> ends with the <code>.fifo</code> suffix. * </p> * </note></li> * <li> * <p> * <code>ContentBasedDeduplication</code> - Returns whether content-based deduplication is enabled for the * queue. For more information, see <a href= * "http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing" * >Exactly-Once Processing</a> in the <i>Amazon SQS Developer Guide</i>. * </p> * </li> * @return Returns a reference to this object so that method calls can be chained together. * @see QueueAttributeName */ public GetQueueAttributesRequest withAttributeNames(QueueAttributeName... attributeNames) { com.amazonaws.internal.SdkInternalList<String> attributeNamesCopy = new com.amazonaws.internal.SdkInternalList<String>(attributeNames.length); for (QueueAttributeName value : attributeNames) { attributeNamesCopy.add(value.toString()); } if (getAttributeNames() == null) { setAttributeNames(attributeNamesCopy); } else { getAttributeNames().addAll(attributeNamesCopy); } return this; } /** * Returns a string representation of this object; useful for testing and debugging. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getQueueUrl() != null) sb.append("QueueUrl: ").append(getQueueUrl()).append(","); if (getAttributeNames() != null) sb.append("AttributeNames: ").append(getAttributeNames()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetQueueAttributesRequest == false) return false; GetQueueAttributesRequest other = (GetQueueAttributesRequest) obj; if (other.getQueueUrl() == null ^ this.getQueueUrl() == null) return false; if (other.getQueueUrl() != null && other.getQueueUrl().equals(this.getQueueUrl()) == false) return false; if (other.getAttributeNames() == null ^ this.getAttributeNames() == null) return false; if (other.getAttributeNames() != null && other.getAttributeNames().equals(this.getAttributeNames()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getQueueUrl() == null) ? 0 : getQueueUrl().hashCode()); hashCode = prime * hashCode + ((getAttributeNames() == null) ? 0 : getAttributeNames().hashCode()); return hashCode; } @Override public GetQueueAttributesRequest clone() { return (GetQueueAttributesRequest) super.clone(); } }