|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.sqs.model.GetQueueAttributesRequest
public class GetQueueAttributesRequest
Container for the parameters to the 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.
AmazonSQS.getQueueAttributes(GetQueueAttributesRequest)
Constructor Summary | |
---|---|
GetQueueAttributesRequest()
Default constructor for a new GetQueueAttributesRequest object. |
|
GetQueueAttributesRequest(String queueUrl)
Constructs a new GetQueueAttributesRequest object. |
Method Summary | |
---|---|
boolean |
equals(Object obj)
|
List<String> |
getAttributeNames()
A list of attributes to retrieve information for. |
String |
getQueueUrl()
The URL of the 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 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(String... attributeNames)
A list of attributes to retrieve information for. |
GetQueueAttributesRequest |
withQueueUrl(String queueUrl)
The URL of the SQS queue to take action on. |
Methods inherited from class com.amazonaws.AmazonWebServiceRequest |
---|
copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, setDelegationToken, setRequestCredentials |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public GetQueueAttributesRequest()
public GetQueueAttributesRequest(String queueUrl)
queueUrl
- The URL of the SQS queue to take action on.Method Detail |
---|
public String getQueueUrl()
public void setQueueUrl(String queueUrl)
queueUrl
- The URL of the 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 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 String toString()
toString
in class Object
Object.toString()
public int hashCode()
hashCode
in class Object
public boolean equals(Object obj)
equals
in class Object
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |