/* * Copyright 2018-2023 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; /** *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class GetQueueAttributesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

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

*

* Queue URLs and names are case-sensitive. *

*/ private String queueUrl; /** *

* A list of attributes for which to retrieve information. *

*

* The AttributeNames parameter is optional, but if you don't specify values for this parameter, the * request returns empty results. *

* *

* 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: *

* *

* The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, and * ApproximateNumberOfMessages metrics may not achieve consistency until at least 1 minute after the * producers stop sending messages. This period is required for the queue metadata to reach eventual consistency. *

* * *

* The following attributes apply only to dead-letter queues: *

* * *

* The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard * queue must also be a standard queue. *

* *

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

* *

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

* *

* The following attributes apply only to high * throughput for FIFO queues: *

* *

* To enable high throughput for FIFO queues, do the following: *

* *

* If you set these attributes to anything other than the values shown for enabling high throughput, normal * throughput is in effect and deduplication occurs as specified. *

*

* For information on throughput quotas, see Quotas * related to messages in the Amazon SQS Developer Guide. *

*/ private com.amazonaws.internal.SdkInternalList 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.

*

* Queue URLs and names 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.

*

* Queue URLs and names are case-sensitive. * @param attributeNames * A list of attributes for which to retrieve information. *

*

* The AttributeNames parameter is optional, but if you don't specify values for this parameter, * the request returns empty results. *

* *

* 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: *

* *

* The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, * and ApproximateNumberOfMessages metrics may not achieve consistency until at least 1 minute * after the producers stop sending messages. This period is required for the queue metadata to reach * eventual consistency. *

* * *

* The following attributes apply only to dead-letter queues: *

* * *

* The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a * standard queue must also be a standard queue. *

* *

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

* *

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

* *

* The following attributes apply only to high throughput for FIFO queues: *

* *

* To enable high throughput for FIFO queues, do the following: *

* *

* If you set these attributes to anything other than the values shown for enabling high throughput, normal * throughput is in effect and deduplication occurs as specified. *

*

* For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide. */ public GetQueueAttributesRequest(String queueUrl, java.util.List attributeNames) { setQueueUrl(queueUrl); setAttributeNames(attributeNames); } /** *

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

*

* Queue URLs and names are case-sensitive. *

* * @param queueUrl * The URL of the Amazon SQS queue whose attribute information is retrieved.

*

* Queue URLs and names are case-sensitive. */ public void setQueueUrl(String queueUrl) { this.queueUrl = queueUrl; } /** *

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

*

* Queue URLs and names are case-sensitive. *

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

*

* Queue URLs and names are case-sensitive. */ public String getQueueUrl() { return this.queueUrl; } /** *

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

*

* Queue URLs and names are case-sensitive. *

* * @param queueUrl * The URL of the Amazon SQS queue whose attribute information is retrieved.

*

* Queue URLs and names 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; } /** *

* A list of attributes for which to retrieve information. *

*

* The AttributeNames parameter is optional, but if you don't specify values for this parameter, the * request returns empty results. *

* *

* 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: *

* *

* The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, and * ApproximateNumberOfMessages metrics may not achieve consistency until at least 1 minute after the * producers stop sending messages. This period is required for the queue metadata to reach eventual consistency. *

* * *

* The following attributes apply only to dead-letter queues: *

* * *

* The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard * queue must also be a standard queue. *

* *

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

* *

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

* *

* The following attributes apply only to high * throughput for FIFO queues: *

* *

* To enable high throughput for FIFO queues, do the following: *

* *

* If you set these attributes to anything other than the values shown for enabling high throughput, normal * throughput is in effect and deduplication occurs as specified. *

*

* For information on throughput quotas, see Quotas * related to messages in the Amazon SQS Developer Guide. *

* * @return A list of attributes for which to retrieve information.

*

* The AttributeNames parameter is optional, but if you don't specify values for this * parameter, the request returns empty results. *

* *

* 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: *

* *

* The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, * and ApproximateNumberOfMessages metrics may not achieve consistency until at least 1 minute * after the producers stop sending messages. This period is required for the queue metadata to reach * eventual consistency. *

* * *

* The following attributes apply only to dead-letter queues: *

* * *

* The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a * standard queue must also be a standard queue. *

* *

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

* *

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

* *

* The following attributes apply only to high throughput for FIFO queues: *

* *

* To enable high throughput for FIFO queues, do the following: *

* *

* If you set these attributes to anything other than the values shown for enabling high throughput, normal * throughput is in effect and deduplication occurs as specified. *

*

* For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide. * @see QueueAttributeName */ public java.util.List getAttributeNames() { if (attributeNames == null) { attributeNames = new com.amazonaws.internal.SdkInternalList(); } return attributeNames; } /** *

* A list of attributes for which to retrieve information. *

*

* The AttributeNames parameter is optional, but if you don't specify values for this parameter, the * request returns empty results. *

* *

* 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: *

* *

* The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, and * ApproximateNumberOfMessages metrics may not achieve consistency until at least 1 minute after the * producers stop sending messages. This period is required for the queue metadata to reach eventual consistency. *

* * *

* The following attributes apply only to dead-letter queues: *

* * *

* The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard * queue must also be a standard queue. *

* *

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

* *

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

* *

* The following attributes apply only to high * throughput for FIFO queues: *

* *

* To enable high throughput for FIFO queues, do the following: *

* *

* If you set these attributes to anything other than the values shown for enabling high throughput, normal * throughput is in effect and deduplication occurs as specified. *

*

* For information on throughput quotas, see Quotas * related to messages in the Amazon SQS Developer Guide. *

* * @param attributeNames * A list of attributes for which to retrieve information.

*

* The AttributeNames parameter is optional, but if you don't specify values for this parameter, * the request returns empty results. *

* *

* 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: *

* *

* The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, * and ApproximateNumberOfMessages metrics may not achieve consistency until at least 1 minute * after the producers stop sending messages. This period is required for the queue metadata to reach * eventual consistency. *

* * *

* The following attributes apply only to dead-letter queues: *

* * *

* The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a * standard queue must also be a standard queue. *

* *

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

* *

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

* *

* The following attributes apply only to high throughput for FIFO queues: *

* *

* To enable high throughput for FIFO queues, do the following: *

* *

* If you set these attributes to anything other than the values shown for enabling high throughput, normal * throughput is in effect and deduplication occurs as specified. *

*

* For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide. * @see QueueAttributeName */ public void setAttributeNames(java.util.Collection attributeNames) { if (attributeNames == null) { this.attributeNames = null; return; } this.attributeNames = new com.amazonaws.internal.SdkInternalList(attributeNames); } /** *

* A list of attributes for which to retrieve information. *

*

* The AttributeNames parameter is optional, but if you don't specify values for this parameter, the * request returns empty results. *

* *

* 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: *

* *

* The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, and * ApproximateNumberOfMessages metrics may not achieve consistency until at least 1 minute after the * producers stop sending messages. This period is required for the queue metadata to reach eventual consistency. *

* * *

* The following attributes apply only to dead-letter queues: *

* * *

* The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard * queue must also be a standard queue. *

* *

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

* *

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

* *

* The following attributes apply only to high * throughput for FIFO queues: *

* *

* To enable high throughput for FIFO queues, do the following: *

* *

* If you set these attributes to anything other than the values shown for enabling high throughput, normal * throughput is in effect and deduplication occurs as specified. *

*

* For information on throughput quotas, see Quotas * related to messages in the Amazon SQS Developer Guide. *

*

* NOTE: 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. *

* * @param attributeNames * A list of attributes for which to retrieve information.

*

* The AttributeNames parameter is optional, but if you don't specify values for this parameter, * the request returns empty results. *

* *

* 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: *

* *

* The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, * and ApproximateNumberOfMessages metrics may not achieve consistency until at least 1 minute * after the producers stop sending messages. This period is required for the queue metadata to reach * eventual consistency. *

* * *

* The following attributes apply only to dead-letter queues: *

* * *

* The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a * standard queue must also be a standard queue. *

* *

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

* *

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

* *

* The following attributes apply only to high throughput for FIFO queues: *

* *

* To enable high throughput for FIFO queues, do the following: *

* *

* If you set these attributes to anything other than the values shown for enabling high throughput, normal * throughput is in effect and deduplication occurs as specified. *

*

* For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide. * @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(attributeNames.length)); } for (String ele : attributeNames) { this.attributeNames.add(ele); } return this; } /** *

* A list of attributes for which to retrieve information. *

*

* The AttributeNames parameter is optional, but if you don't specify values for this parameter, the * request returns empty results. *

* *

* 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: *

* *

* The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, and * ApproximateNumberOfMessages metrics may not achieve consistency until at least 1 minute after the * producers stop sending messages. This period is required for the queue metadata to reach eventual consistency. *

* * *

* The following attributes apply only to dead-letter queues: *

* * *

* The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard * queue must also be a standard queue. *

* *

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

* *

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

* *

* The following attributes apply only to high * throughput for FIFO queues: *

* *

* To enable high throughput for FIFO queues, do the following: *

* *

* If you set these attributes to anything other than the values shown for enabling high throughput, normal * throughput is in effect and deduplication occurs as specified. *

*

* For information on throughput quotas, see Quotas * related to messages in the Amazon SQS Developer Guide. *

* * @param attributeNames * A list of attributes for which to retrieve information.

*

* The AttributeNames parameter is optional, but if you don't specify values for this parameter, * the request returns empty results. *

* *

* 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: *

* *

* The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, * and ApproximateNumberOfMessages metrics may not achieve consistency until at least 1 minute * after the producers stop sending messages. This period is required for the queue metadata to reach * eventual consistency. *

* * *

* The following attributes apply only to dead-letter queues: *

* * *

* The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a * standard queue must also be a standard queue. *

* *

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

* *

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

* *

* The following attributes apply only to high throughput for FIFO queues: *

* *

* To enable high throughput for FIFO queues, do the following: *

* *

* If you set these attributes to anything other than the values shown for enabling high throughput, normal * throughput is in effect and deduplication occurs as specified. *

*

* For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. * @see QueueAttributeName */ public GetQueueAttributesRequest withAttributeNames(java.util.Collection attributeNames) { setAttributeNames(attributeNames); return this; } /** *

* A list of attributes for which to retrieve information. *

*

* The AttributeNames parameter is optional, but if you don't specify values for this parameter, the * request returns empty results. *

* *

* 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: *

* *

* The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, and * ApproximateNumberOfMessages metrics may not achieve consistency until at least 1 minute after the * producers stop sending messages. This period is required for the queue metadata to reach eventual consistency. *

* * *

* The following attributes apply only to dead-letter queues: *

* * *

* The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard * queue must also be a standard queue. *

* *

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

* *

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

* *

* The following attributes apply only to high * throughput for FIFO queues: *

* *

* To enable high throughput for FIFO queues, do the following: *

* *

* If you set these attributes to anything other than the values shown for enabling high throughput, normal * throughput is in effect and deduplication occurs as specified. *

*

* For information on throughput quotas, see Quotas * related to messages in the Amazon SQS Developer Guide. *

* * @param attributeNames * A list of attributes for which to retrieve information.

*

* The AttributeNames parameter is optional, but if you don't specify values for this parameter, * the request returns empty results. *

* *

* 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: *

* *

* The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, * and ApproximateNumberOfMessages metrics may not achieve consistency until at least 1 minute * after the producers stop sending messages. This period is required for the queue metadata to reach * eventual consistency. *

* * *

* The following attributes apply only to dead-letter queues: *

* * *

* The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a * standard queue must also be a standard queue. *

* *

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

* *

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

* *

* The following attributes apply only to high throughput for FIFO queues: *

* *

* To enable high throughput for FIFO queues, do the following: *

* *

* If you set these attributes to anything other than the values shown for enabling high throughput, normal * throughput is in effect and deduplication occurs as specified. *

*

* For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide. * @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 attributeNamesCopy = new com.amazonaws.internal.SdkInternalList(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. This is useful for testing and debugging. Sensitive data will be * redacted from this string using a placeholder value. * * @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(); } }