GetQueueAttributesRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.sqs.model.SqsRequest
    - - software.amazon.awssdk.services.sqs.model.GetQueueAttributesRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetQueueAttributesRequest.Builder,GetQueueAttributesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetQueueAttributesRequest
extends SqsRequest
implements ToCopyableBuilder<GetQueueAttributesRequest.Builder,GetQueueAttributesRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetQueueAttributesRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetQueueAttributesRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<QueueAttributeName>`	`attributeNames()` A list of attributes for which to retrieve information.
`List<String>`	`attributeNamesAsStrings()` A list of attributes for which to retrieve information.
`static GetQueueAttributesRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`String`	`queueUrl()` The URL of the Amazon SQS queue whose attribute information is retrieved.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetQueueAttributesRequest.Builder>`	`serializableBuilderClass()`
`GetQueueAttributesRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - queueUrl
```
public String queueUrl()
```
    The URL of the Amazon SQS queue whose attribute information is retrieved.
    
    Queue URLs and names are case-sensitive.
    
    Returns:
    
    The URL of the Amazon SQS queue whose attribute information is retrieved.
    
    Queue URLs and names are case-sensitive.
  - attributeNames
```
public List<QueueAttributeName> attributeNames()
```
    A list of attributes for which to retrieve information.
    
    In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
    
    The following attributes are supported:
    - All - Returns all values.
    - ApproximateNumberOfMessages - Returns the approximate number of messages available for retrieval from the queue.
    - ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter.
    - ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that are in flight. Messages are considered to be in flight if they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility window.
    - CreatedTimestamp - Returns the time when the queue was created in seconds (epoch time).
    - DelaySeconds - Returns the default delay on the queue in seconds.
    - LastModifiedTimestamp - Returns the time when the queue was last changed in seconds (epoch time).
    - MaximumMessageSize - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.
    - MessageRetentionPeriod - Returns the length of time, in seconds, for which Amazon SQS retains a message.
    - Policy - Returns the policy of the queue.
    - QueueArn - Returns the Amazon resource name (ARN) of the queue.
    - ReceiveMessageWaitTimeSeconds - Returns the length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.
    - RedrivePolicy - Returns the string that includes the parameters for dead-letter queue functionality of the source queue. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
      
      deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
      
      maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
    - VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
    The following attributes apply only to server-side-encryption:
    - KmsMasterKeyId - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
    - KmsDataKeyReusePeriodSeconds - Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?.
    The following attributes apply only to FIFO (first-in-first-out) queues:
    - FifoQueue - Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide.
      
      To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
    - ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    Returns:
    A list of attributes for which to retrieve information.
    
    In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
    
    The following attributes are supported:
    
    All - Returns all values.
    
    ApproximateNumberOfMessages - Returns the approximate number of messages available for retrieval from the queue.
    
    ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter.
    
    ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that are in flight. Messages are considered to be in flight if they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility window.
    
    CreatedTimestamp - Returns the time when the queue was created in seconds (epoch time).
    
    DelaySeconds - Returns the default delay on the queue in seconds.
    
    LastModifiedTimestamp - Returns the time when the queue was last changed in seconds (epoch time).
    
    MaximumMessageSize - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.
    
    MessageRetentionPeriod - Returns the length of time, in seconds, for which Amazon SQS retains a message.
    
    Policy - Returns the policy of the queue.
    
    QueueArn - Returns the Amazon resource name (ARN) of the queue.
    
    ReceiveMessageWaitTimeSeconds - Returns the length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.
    
    RedrivePolicy - Returns the string that includes the parameters for dead-letter queue functionality of the source queue. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
    
    deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
    
    maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
    
    VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
    
    The following attributes apply only to server-side-encryption:
    
    KmsMasterKeyId - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
    
    KmsDataKeyReusePeriodSeconds - Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?.
    
    The following attributes apply only to FIFO (first-in-first-out) queues:
    
    FifoQueue - Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide.
    
    To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
    
    ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
  - attributeNamesAsStrings
```
public List<String> attributeNamesAsStrings()
```
    A list of attributes for which to retrieve information.
    
    In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
    
    The following attributes are supported:
    - All - Returns all values.
    - ApproximateNumberOfMessages - Returns the approximate number of messages available for retrieval from the queue.
    - ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter.
    - ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that are in flight. Messages are considered to be in flight if they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility window.
    - CreatedTimestamp - Returns the time when the queue was created in seconds (epoch time).
    - DelaySeconds - Returns the default delay on the queue in seconds.
    - LastModifiedTimestamp - Returns the time when the queue was last changed in seconds (epoch time).
    - MaximumMessageSize - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.
    - MessageRetentionPeriod - Returns the length of time, in seconds, for which Amazon SQS retains a message.
    - Policy - Returns the policy of the queue.
    - QueueArn - Returns the Amazon resource name (ARN) of the queue.
    - ReceiveMessageWaitTimeSeconds - Returns the length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.
    - RedrivePolicy - Returns the string that includes the parameters for dead-letter queue functionality of the source queue. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
      
      deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
      
      maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
    - VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
    The following attributes apply only to server-side-encryption:
    - KmsMasterKeyId - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
    - KmsDataKeyReusePeriodSeconds - Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?.
    The following attributes apply only to FIFO (first-in-first-out) queues:
    - FifoQueue - Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide.
      
      To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
    - ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    Returns:
    A list of attributes for which to retrieve information.
    
    In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
    
    The following attributes are supported:
    
    All - Returns all values.
    
    ApproximateNumberOfMessages - Returns the approximate number of messages available for retrieval from the queue.
    
    ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter.
    
    ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that are in flight. Messages are considered to be in flight if they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility window.
    
    CreatedTimestamp - Returns the time when the queue was created in seconds (epoch time).
    
    DelaySeconds - Returns the default delay on the queue in seconds.
    
    LastModifiedTimestamp - Returns the time when the queue was last changed in seconds (epoch time).
    
    MaximumMessageSize - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.
    
    MessageRetentionPeriod - Returns the length of time, in seconds, for which Amazon SQS retains a message.
    
    Policy - Returns the policy of the queue.
    
    QueueArn - Returns the Amazon resource name (ARN) of the queue.
    
    ReceiveMessageWaitTimeSeconds - Returns the length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.
    
    RedrivePolicy - Returns the string that includes the parameters for dead-letter queue functionality of the source queue. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
    
    deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
    
    maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
    
    VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
    
    The following attributes apply only to server-side-encryption:
    
    KmsMasterKeyId - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
    
    KmsDataKeyReusePeriodSeconds - Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?.
    
    The following attributes apply only to FIFO (first-in-first-out) queues:
    
    FifoQueue - Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide.
    
    To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
    
    ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
  - toBuilder
```
public GetQueueAttributesRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetQueueAttributesRequest.Builder,GetQueueAttributesRequest>
    
    Specified by:
    
    toBuilder in class SqsRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static GetQueueAttributesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetQueueAttributesRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class GetQueueAttributesRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

queueUrl

attributeNames

attributeNamesAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields