public class GetQueueAttributesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
GetQueueAttributesRequest()
Default constructor for GetQueueAttributesRequest object.
|
GetQueueAttributesRequest(String queueUrl)
Constructs a new GetQueueAttributesRequest object.
|
GetQueueAttributesRequest(String queueUrl,
List<String> attributeNames)
Constructs a new GetQueueAttributesRequest object.
|
Modifier and Type | Method and Description |
---|---|
GetQueueAttributesRequest |
clone() |
boolean |
equals(Object obj) |
List<String> |
getAttributeNames()
A list of attributes to retrieve information for.
|
String |
getQueueUrl()
The URL of the Amazon SQS queue to take action on.
|
int |
hashCode() |
void |
setAttributeNames(Collection<String> attributeNames)
A list of attributes to retrieve information for.
|
void |
setQueueUrl(String queueUrl)
The URL of the Amazon SQS queue to take action on.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
GetQueueAttributesRequest |
withAttributeNames(Collection<String> attributeNames)
A list of attributes to retrieve information for.
|
GetQueueAttributesRequest |
withAttributeNames(QueueAttributeName... attributeNames)
A list of attributes to retrieve information for.
|
GetQueueAttributesRequest |
withAttributeNames(String... attributeNames)
A list of attributes to retrieve information for.
|
GetQueueAttributesRequest |
withQueueUrl(String queueUrl)
The URL of the Amazon SQS queue to take action on.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public GetQueueAttributesRequest()
public GetQueueAttributesRequest(String queueUrl)
queueUrl
- The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
public GetQueueAttributesRequest(String queueUrl, List<String> attributeNames)
queueUrl
- The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
attributeNames
- A list of attributes to retrieve information for. The following
attributes are supported:
All
- returns all values.
ApproximateNumberOfMessages
- returns the approximate
number of visible messages in a queue. For more information, see
Resources Required to Process Messages in the Amazon SQS
Developer Guide.
ApproximateNumberOfMessagesNotVisible
- returns the
approximate number of messages that are not timed-out and not
deleted. For more information, see Resources Required to Process Messages in the Amazon SQS
Developer Guide.
VisibilityTimeout
- returns the visibility timeout
for the queue. For more information about visibility timeout, see
Visibility Timeout in the Amazon SQS Developer Guide.
CreatedTimestamp
- returns the time when the queue
was created (epoch time in seconds).
LastModifiedTimestamp
- returns the time when the
queue was last changed (epoch time in seconds).
Policy
- returns the queue's policy.
MaximumMessageSize
- returns the limit of how many
bytes a message can contain before Amazon SQS rejects it.
MessageRetentionPeriod
- returns the number of
seconds Amazon SQS retains a message.
QueueArn
- returns the queue's Amazon resource name
(ARN).
ApproximateNumberOfMessagesDelayed
- returns the
approximate number of messages that are pending to be added to the
queue.
DelaySeconds
- returns the default delay on the queue
in seconds.
ReceiveMessageWaitTimeSeconds
- returns the time for
which a ReceiveMessage call will wait for a message to arrive.
RedrivePolicy
- returns the parameters for dead
letter queue functionality of the source queue. For more
information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS
Developer Guide.
Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
public void setQueueUrl(String queueUrl)
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
queueUrl
- The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
public String getQueueUrl()
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
Queue URLs are case-sensitive.
public GetQueueAttributesRequest withQueueUrl(String queueUrl)
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
queueUrl
- The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
public List<String> getAttributeNames()
A list of attributes to retrieve information for. The following attributes are supported:
All
- returns all values.
ApproximateNumberOfMessages
- returns the approximate number
of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS
Developer Guide.
ApproximateNumberOfMessagesNotVisible
- returns the
approximate number of messages that are not timed-out and not deleted.
For more information, see Resources Required to Process Messages in the Amazon SQS
Developer Guide.
VisibilityTimeout
- returns the visibility timeout for the
queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
CreatedTimestamp
- returns the time when the queue was
created (epoch time in seconds).
LastModifiedTimestamp
- returns the time when the queue was
last changed (epoch time in seconds).
Policy
- returns the queue's policy.
MaximumMessageSize
- returns the limit of how many bytes a
message can contain before Amazon SQS rejects it.
MessageRetentionPeriod
- returns the number of seconds
Amazon SQS retains a message.
QueueArn
- returns the queue's Amazon resource name (ARN).
ApproximateNumberOfMessagesDelayed
- returns the approximate
number of messages that are pending to be added to the queue.
DelaySeconds
- returns the default delay on the queue in
seconds.
ReceiveMessageWaitTimeSeconds
- returns the time for which a
ReceiveMessage call will wait for a message to arrive.
RedrivePolicy
- returns the parameters for dead letter queue
functionality of the source queue. For more information about
RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer
Guide.
Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
All
- returns all values.
ApproximateNumberOfMessages
- returns the
approximate number of visible messages in a queue. For more
information, see Resources Required to Process Messages in the Amazon SQS
Developer Guide.
ApproximateNumberOfMessagesNotVisible
- returns the
approximate number of messages that are not timed-out and not
deleted. For more information, see Resources Required to Process Messages in the Amazon SQS
Developer Guide.
VisibilityTimeout
- returns the visibility timeout
for the queue. For more information about visibility timeout, see
Visibility Timeout in the Amazon SQS Developer Guide.
CreatedTimestamp
- returns the time when the queue
was created (epoch time in seconds).
LastModifiedTimestamp
- returns the time when the
queue was last changed (epoch time in seconds).
Policy
- returns the queue's policy.
MaximumMessageSize
- returns the limit of how many
bytes a message can contain before Amazon SQS rejects it.
MessageRetentionPeriod
- returns the number of
seconds Amazon SQS retains a message.
QueueArn
- returns the queue's Amazon resource name
(ARN).
ApproximateNumberOfMessagesDelayed
- returns the
approximate number of messages that are pending to be added to
the queue.
DelaySeconds
- returns the default delay on the
queue in seconds.
ReceiveMessageWaitTimeSeconds
- returns the time for
which a ReceiveMessage call will wait for a message to arrive.
RedrivePolicy
- returns the parameters for dead
letter queue functionality of the source queue. For more
information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS
Developer Guide.
Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
QueueAttributeName
public void setAttributeNames(Collection<String> attributeNames)
A list of attributes to retrieve information for. The following attributes are supported:
All
- returns all values.
ApproximateNumberOfMessages
- returns the approximate number
of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS
Developer Guide.
ApproximateNumberOfMessagesNotVisible
- returns the
approximate number of messages that are not timed-out and not deleted.
For more information, see Resources Required to Process Messages in the Amazon SQS
Developer Guide.
VisibilityTimeout
- returns the visibility timeout for the
queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
CreatedTimestamp
- returns the time when the queue was
created (epoch time in seconds).
LastModifiedTimestamp
- returns the time when the queue was
last changed (epoch time in seconds).
Policy
- returns the queue's policy.
MaximumMessageSize
- returns the limit of how many bytes a
message can contain before Amazon SQS rejects it.
MessageRetentionPeriod
- returns the number of seconds
Amazon SQS retains a message.
QueueArn
- returns the queue's Amazon resource name (ARN).
ApproximateNumberOfMessagesDelayed
- returns the approximate
number of messages that are pending to be added to the queue.
DelaySeconds
- returns the default delay on the queue in
seconds.
ReceiveMessageWaitTimeSeconds
- returns the time for which a
ReceiveMessage call will wait for a message to arrive.
RedrivePolicy
- returns the parameters for dead letter queue
functionality of the source queue. For more information about
RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer
Guide.
Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
attributeNames
- A list of attributes to retrieve information for. The following
attributes are supported:
All
- returns all values.
ApproximateNumberOfMessages
- returns the approximate
number of visible messages in a queue. For more information, see
Resources Required to Process Messages in the Amazon SQS
Developer Guide.
ApproximateNumberOfMessagesNotVisible
- returns the
approximate number of messages that are not timed-out and not
deleted. For more information, see Resources Required to Process Messages in the Amazon SQS
Developer Guide.
VisibilityTimeout
- returns the visibility timeout
for the queue. For more information about visibility timeout, see
Visibility Timeout in the Amazon SQS Developer Guide.
CreatedTimestamp
- returns the time when the queue
was created (epoch time in seconds).
LastModifiedTimestamp
- returns the time when the
queue was last changed (epoch time in seconds).
Policy
- returns the queue's policy.
MaximumMessageSize
- returns the limit of how many
bytes a message can contain before Amazon SQS rejects it.
MessageRetentionPeriod
- returns the number of
seconds Amazon SQS retains a message.
QueueArn
- returns the queue's Amazon resource name
(ARN).
ApproximateNumberOfMessagesDelayed
- returns the
approximate number of messages that are pending to be added to the
queue.
DelaySeconds
- returns the default delay on the queue
in seconds.
ReceiveMessageWaitTimeSeconds
- returns the time for
which a ReceiveMessage call will wait for a message to arrive.
RedrivePolicy
- returns the parameters for dead
letter queue functionality of the source queue. For more
information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS
Developer Guide.
Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
QueueAttributeName
public GetQueueAttributesRequest withAttributeNames(String... attributeNames)
A list of attributes to retrieve information for. The following attributes are supported:
All
- returns all values.
ApproximateNumberOfMessages
- returns the approximate number
of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS
Developer Guide.
ApproximateNumberOfMessagesNotVisible
- returns the
approximate number of messages that are not timed-out and not deleted.
For more information, see Resources Required to Process Messages in the Amazon SQS
Developer Guide.
VisibilityTimeout
- returns the visibility timeout for the
queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
CreatedTimestamp
- returns the time when the queue was
created (epoch time in seconds).
LastModifiedTimestamp
- returns the time when the queue was
last changed (epoch time in seconds).
Policy
- returns the queue's policy.
MaximumMessageSize
- returns the limit of how many bytes a
message can contain before Amazon SQS rejects it.
MessageRetentionPeriod
- returns the number of seconds
Amazon SQS retains a message.
QueueArn
- returns the queue's Amazon resource name (ARN).
ApproximateNumberOfMessagesDelayed
- returns the approximate
number of messages that are pending to be added to the queue.
DelaySeconds
- returns the default delay on the queue in
seconds.
ReceiveMessageWaitTimeSeconds
- returns the time for which a
ReceiveMessage call will wait for a message to arrive.
RedrivePolicy
- returns the parameters for dead letter queue
functionality of the source queue. For more information about
RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer
Guide.
Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
NOTE: This method appends the values to the existing list (if
any). Use setAttributeNames(java.util.Collection)
or
withAttributeNames(java.util.Collection)
if you want to override
the existing values.
attributeNames
- A list of attributes to retrieve information for. The following
attributes are supported:
All
- returns all values.
ApproximateNumberOfMessages
- returns the approximate
number of visible messages in a queue. For more information, see
Resources Required to Process Messages in the Amazon SQS
Developer Guide.
ApproximateNumberOfMessagesNotVisible
- returns the
approximate number of messages that are not timed-out and not
deleted. For more information, see Resources Required to Process Messages in the Amazon SQS
Developer Guide.
VisibilityTimeout
- returns the visibility timeout
for the queue. For more information about visibility timeout, see
Visibility Timeout in the Amazon SQS Developer Guide.
CreatedTimestamp
- returns the time when the queue
was created (epoch time in seconds).
LastModifiedTimestamp
- returns the time when the
queue was last changed (epoch time in seconds).
Policy
- returns the queue's policy.
MaximumMessageSize
- returns the limit of how many
bytes a message can contain before Amazon SQS rejects it.
MessageRetentionPeriod
- returns the number of
seconds Amazon SQS retains a message.
QueueArn
- returns the queue's Amazon resource name
(ARN).
ApproximateNumberOfMessagesDelayed
- returns the
approximate number of messages that are pending to be added to the
queue.
DelaySeconds
- returns the default delay on the queue
in seconds.
ReceiveMessageWaitTimeSeconds
- returns the time for
which a ReceiveMessage call will wait for a message to arrive.
RedrivePolicy
- returns the parameters for dead
letter queue functionality of the source queue. For more
information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS
Developer Guide.
Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
QueueAttributeName
public GetQueueAttributesRequest withAttributeNames(Collection<String> attributeNames)
A list of attributes to retrieve information for. The following attributes are supported:
All
- returns all values.
ApproximateNumberOfMessages
- returns the approximate number
of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS
Developer Guide.
ApproximateNumberOfMessagesNotVisible
- returns the
approximate number of messages that are not timed-out and not deleted.
For more information, see Resources Required to Process Messages in the Amazon SQS
Developer Guide.
VisibilityTimeout
- returns the visibility timeout for the
queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
CreatedTimestamp
- returns the time when the queue was
created (epoch time in seconds).
LastModifiedTimestamp
- returns the time when the queue was
last changed (epoch time in seconds).
Policy
- returns the queue's policy.
MaximumMessageSize
- returns the limit of how many bytes a
message can contain before Amazon SQS rejects it.
MessageRetentionPeriod
- returns the number of seconds
Amazon SQS retains a message.
QueueArn
- returns the queue's Amazon resource name (ARN).
ApproximateNumberOfMessagesDelayed
- returns the approximate
number of messages that are pending to be added to the queue.
DelaySeconds
- returns the default delay on the queue in
seconds.
ReceiveMessageWaitTimeSeconds
- returns the time for which a
ReceiveMessage call will wait for a message to arrive.
RedrivePolicy
- returns the parameters for dead letter queue
functionality of the source queue. For more information about
RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer
Guide.
Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
attributeNames
- A list of attributes to retrieve information for. The following
attributes are supported:
All
- returns all values.
ApproximateNumberOfMessages
- returns the approximate
number of visible messages in a queue. For more information, see
Resources Required to Process Messages in the Amazon SQS
Developer Guide.
ApproximateNumberOfMessagesNotVisible
- returns the
approximate number of messages that are not timed-out and not
deleted. For more information, see Resources Required to Process Messages in the Amazon SQS
Developer Guide.
VisibilityTimeout
- returns the visibility timeout
for the queue. For more information about visibility timeout, see
Visibility Timeout in the Amazon SQS Developer Guide.
CreatedTimestamp
- returns the time when the queue
was created (epoch time in seconds).
LastModifiedTimestamp
- returns the time when the
queue was last changed (epoch time in seconds).
Policy
- returns the queue's policy.
MaximumMessageSize
- returns the limit of how many
bytes a message can contain before Amazon SQS rejects it.
MessageRetentionPeriod
- returns the number of
seconds Amazon SQS retains a message.
QueueArn
- returns the queue's Amazon resource name
(ARN).
ApproximateNumberOfMessagesDelayed
- returns the
approximate number of messages that are pending to be added to the
queue.
DelaySeconds
- returns the default delay on the queue
in seconds.
ReceiveMessageWaitTimeSeconds
- returns the time for
which a ReceiveMessage call will wait for a message to arrive.
RedrivePolicy
- returns the parameters for dead
letter queue functionality of the source queue. For more
information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS
Developer Guide.
Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
QueueAttributeName
public GetQueueAttributesRequest withAttributeNames(QueueAttributeName... attributeNames)
A list of attributes to retrieve information for. The following attributes are supported:
All
- returns all values.
ApproximateNumberOfMessages
- returns the approximate number
of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS
Developer Guide.
ApproximateNumberOfMessagesNotVisible
- returns the
approximate number of messages that are not timed-out and not deleted.
For more information, see Resources Required to Process Messages in the Amazon SQS
Developer Guide.
VisibilityTimeout
- returns the visibility timeout for the
queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
CreatedTimestamp
- returns the time when the queue was
created (epoch time in seconds).
LastModifiedTimestamp
- returns the time when the queue was
last changed (epoch time in seconds).
Policy
- returns the queue's policy.
MaximumMessageSize
- returns the limit of how many bytes a
message can contain before Amazon SQS rejects it.
MessageRetentionPeriod
- returns the number of seconds
Amazon SQS retains a message.
QueueArn
- returns the queue's Amazon resource name (ARN).
ApproximateNumberOfMessagesDelayed
- returns the approximate
number of messages that are pending to be added to the queue.
DelaySeconds
- returns the default delay on the queue in
seconds.
ReceiveMessageWaitTimeSeconds
- returns the time for which a
ReceiveMessage call will wait for a message to arrive.
RedrivePolicy
- returns the parameters for dead letter queue
functionality of the source queue. For more information about
RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer
Guide.
Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
attributeNames
- A list of attributes to retrieve information for. The following
attributes are supported:
All
- returns all values.
ApproximateNumberOfMessages
- returns the approximate
number of visible messages in a queue. For more information, see
Resources Required to Process Messages in the Amazon SQS
Developer Guide.
ApproximateNumberOfMessagesNotVisible
- returns the
approximate number of messages that are not timed-out and not
deleted. For more information, see Resources Required to Process Messages in the Amazon SQS
Developer Guide.
VisibilityTimeout
- returns the visibility timeout
for the queue. For more information about visibility timeout, see
Visibility Timeout in the Amazon SQS Developer Guide.
CreatedTimestamp
- returns the time when the queue
was created (epoch time in seconds).
LastModifiedTimestamp
- returns the time when the
queue was last changed (epoch time in seconds).
Policy
- returns the queue's policy.
MaximumMessageSize
- returns the limit of how many
bytes a message can contain before Amazon SQS rejects it.
MessageRetentionPeriod
- returns the number of
seconds Amazon SQS retains a message.
QueueArn
- returns the queue's Amazon resource name
(ARN).
ApproximateNumberOfMessagesDelayed
- returns the
approximate number of messages that are pending to be added to the
queue.
DelaySeconds
- returns the default delay on the queue
in seconds.
ReceiveMessageWaitTimeSeconds
- returns the time for
which a ReceiveMessage call will wait for a message to arrive.
RedrivePolicy
- returns the parameters for dead
letter queue functionality of the source queue. For more
information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS
Developer Guide.
Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
QueueAttributeName
public String toString()
toString
in class Object
Object.toString()
public GetQueueAttributesRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2016. All rights reserved.