public class GetQueueAttributesRequest extends AmazonWebServiceRequest implements Serializable
GetQueueAttributes operation
.
Gets attributes for the specified queue. 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 .NOTE: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:Some API actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=this
&Attribute.2=that
NOOP
Constructor and Description |
---|
GetQueueAttributesRequest()
Default constructor for a new 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 |
---|---|
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, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public GetQueueAttributesRequest()
public GetQueueAttributesRequest(String queueUrl)
queueUrl
- The URL of the Amazon SQS queue to take action on.public GetQueueAttributesRequest(String queueUrl, List<String> attributeNames)
queueUrl
- The URL of the Amazon SQS queue to take action on.attributeNames
- A list of attributes to retrieve information
for.public String getQueueUrl()
public void setQueueUrl(String queueUrl)
queueUrl
- The URL of the Amazon SQS queue to take action on.public GetQueueAttributesRequest withQueueUrl(String queueUrl)
Returns a reference to this object so that method calls can be chained together.
queueUrl
- The URL of the Amazon SQS queue to take action on.public List<String> getAttributeNames()
public void setAttributeNames(Collection<String> attributeNames)
attributeNames
- A list of attributes to retrieve information for.public GetQueueAttributesRequest withAttributeNames(String... attributeNames)
Returns a reference to this object so that method calls can be chained together.
attributeNames
- A list of attributes to retrieve information for.public GetQueueAttributesRequest withAttributeNames(Collection<String> attributeNames)
Returns a reference to this object so that method calls can be chained together.
attributeNames
- A list of attributes to retrieve information for.public GetQueueAttributesRequest withAttributeNames(QueueAttributeName... attributeNames)
Returns a reference to this object so that method calls can be chained together.
attributeNames
- A list of attributes to retrieve information for.public String toString()
toString
in class Object
Object.toString()
Copyright © 2015. All rights reserved.