Class SetQueueAttributesRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.sqs.model.SetQueueAttributesRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class SetQueueAttributesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description SetQueueAttributesRequest()
Default constructor for SetQueueAttributesRequest object.SetQueueAttributesRequest(String queueUrl, Map<String,String> attributes)
Constructs a new SetQueueAttributesRequest object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SetQueueAttributesRequest
addAttributesEntry(String key, String value)
SetQueueAttributesRequest
clearAttributesEntries()
Removes all the entries added into Attributes.SetQueueAttributesRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
Map<String,String>
getAttributes()
A map of attributes to set.String
getQueueUrl()
The URL of the Amazon SQS queue to take action on.int
hashCode()
void
setAttributes(Map<String,String> attributes)
A map of attributes to set.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.SetQueueAttributesRequest
withAttributes(Map<String,String> attributes)
A map of attributes to set.SetQueueAttributesRequest
withQueueUrl(String queueUrl)
The URL of the Amazon SQS queue to take action on.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
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
-
-
-
-
Constructor Detail
-
SetQueueAttributesRequest
public SetQueueAttributesRequest()
Default constructor for SetQueueAttributesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
-
SetQueueAttributesRequest
public SetQueueAttributesRequest(String queueUrl, Map<String,String> attributes)
Constructs a new SetQueueAttributesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
queueUrl
- The URL of the Amazon SQS queue to take action on.Queue URLs are case-sensitive.
attributes
- A map of attributes to set.The following lists the names, descriptions, and values of the special request parameters the
SetQueueAttributes
action uses:-
DelaySeconds
- The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 (zero). -
MaximumMessageSize
- The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB). -
MessageRetentionPeriod
- The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days). -
Policy
- The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide. -
ReceiveMessageWaitTimeSeconds
- The time for which a ReceiveMessage call will wait for a message to arrive. An integer from 0 to 20 (seconds). The default for this attribute is 0. -
VisibilityTimeout
- The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide. -
RedrivePolicy
- 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.
Any other valid special request parameters that are specified (such as
ApproximateNumberOfMessages
,ApproximateNumberOfMessagesDelayed
,ApproximateNumberOfMessagesNotVisible
,CreatedTimestamp
,LastModifiedTimestamp
, andQueueArn
) will be ignored.-
-
-
Method Detail
-
setQueueUrl
public void setQueueUrl(String queueUrl)
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
- Parameters:
queueUrl
- The URL of the Amazon SQS queue to take action on.Queue URLs are case-sensitive.
-
getQueueUrl
public String getQueueUrl()
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
- Returns:
- The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
-
withQueueUrl
public SetQueueAttributesRequest withQueueUrl(String queueUrl)
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
- Parameters:
queueUrl
- The URL of the Amazon SQS queue to take action on.Queue URLs are case-sensitive.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getAttributes
public Map<String,String> getAttributes()
A map of attributes to set.
The following lists the names, descriptions, and values of the special request parameters the
SetQueueAttributes
action uses:-
DelaySeconds
- The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 (zero). -
MaximumMessageSize
- The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB). -
MessageRetentionPeriod
- The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days). -
Policy
- The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide. -
ReceiveMessageWaitTimeSeconds
- The time for which a ReceiveMessage call will wait for a message to arrive. An integer from 0 to 20 (seconds). The default for this attribute is 0. -
VisibilityTimeout
- The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide. -
RedrivePolicy
- 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.
Any other valid special request parameters that are specified (such as
ApproximateNumberOfMessages
,ApproximateNumberOfMessagesDelayed
,ApproximateNumberOfMessagesNotVisible
,CreatedTimestamp
,LastModifiedTimestamp
, andQueueArn
) will be ignored.- Returns:
- A map of attributes to set.
The following lists the names, descriptions, and values of the special request parameters the
SetQueueAttributes
action uses:-
DelaySeconds
- The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 (zero). -
MaximumMessageSize
- The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB). -
MessageRetentionPeriod
- The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days). -
Policy
- The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide. -
ReceiveMessageWaitTimeSeconds
- The time for which a ReceiveMessage call will wait for a message to arrive. An integer from 0 to 20 (seconds). The default for this attribute is 0. -
VisibilityTimeout
- The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide. -
RedrivePolicy
- 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.
Any other valid special request parameters that are specified (such as
ApproximateNumberOfMessages
,ApproximateNumberOfMessagesDelayed
,ApproximateNumberOfMessagesNotVisible
,CreatedTimestamp
,LastModifiedTimestamp
, andQueueArn
) will be ignored. -
-
-
setAttributes
public void setAttributes(Map<String,String> attributes)
A map of attributes to set.
The following lists the names, descriptions, and values of the special request parameters the
SetQueueAttributes
action uses:-
DelaySeconds
- The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 (zero). -
MaximumMessageSize
- The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB). -
MessageRetentionPeriod
- The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days). -
Policy
- The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide. -
ReceiveMessageWaitTimeSeconds
- The time for which a ReceiveMessage call will wait for a message to arrive. An integer from 0 to 20 (seconds). The default for this attribute is 0. -
VisibilityTimeout
- The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide. -
RedrivePolicy
- 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.
Any other valid special request parameters that are specified (such as
ApproximateNumberOfMessages
,ApproximateNumberOfMessagesDelayed
,ApproximateNumberOfMessagesNotVisible
,CreatedTimestamp
,LastModifiedTimestamp
, andQueueArn
) will be ignored.- Parameters:
attributes
- A map of attributes to set.The following lists the names, descriptions, and values of the special request parameters the
SetQueueAttributes
action uses:-
DelaySeconds
- The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 (zero). -
MaximumMessageSize
- The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB). -
MessageRetentionPeriod
- The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days). -
Policy
- The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide. -
ReceiveMessageWaitTimeSeconds
- The time for which a ReceiveMessage call will wait for a message to arrive. An integer from 0 to 20 (seconds). The default for this attribute is 0. -
VisibilityTimeout
- The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide. -
RedrivePolicy
- 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.
Any other valid special request parameters that are specified (such as
ApproximateNumberOfMessages
,ApproximateNumberOfMessagesDelayed
,ApproximateNumberOfMessagesNotVisible
,CreatedTimestamp
,LastModifiedTimestamp
, andQueueArn
) will be ignored.-
-
-
withAttributes
public SetQueueAttributesRequest withAttributes(Map<String,String> attributes)
A map of attributes to set.
The following lists the names, descriptions, and values of the special request parameters the
SetQueueAttributes
action uses:-
DelaySeconds
- The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 (zero). -
MaximumMessageSize
- The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB). -
MessageRetentionPeriod
- The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days). -
Policy
- The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide. -
ReceiveMessageWaitTimeSeconds
- The time for which a ReceiveMessage call will wait for a message to arrive. An integer from 0 to 20 (seconds). The default for this attribute is 0. -
VisibilityTimeout
- The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide. -
RedrivePolicy
- 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.
Any other valid special request parameters that are specified (such as
ApproximateNumberOfMessages
,ApproximateNumberOfMessagesDelayed
,ApproximateNumberOfMessagesNotVisible
,CreatedTimestamp
,LastModifiedTimestamp
, andQueueArn
) will be ignored.- Parameters:
attributes
- A map of attributes to set.The following lists the names, descriptions, and values of the special request parameters the
SetQueueAttributes
action uses:-
DelaySeconds
- The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 (zero). -
MaximumMessageSize
- The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB). -
MessageRetentionPeriod
- The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days). -
Policy
- The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide. -
ReceiveMessageWaitTimeSeconds
- The time for which a ReceiveMessage call will wait for a message to arrive. An integer from 0 to 20 (seconds). The default for this attribute is 0. -
VisibilityTimeout
- The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide. -
RedrivePolicy
- 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.
Any other valid special request parameters that are specified (such as
ApproximateNumberOfMessages
,ApproximateNumberOfMessagesDelayed
,ApproximateNumberOfMessagesNotVisible
,CreatedTimestamp
,LastModifiedTimestamp
, andQueueArn
) will be ignored.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
addAttributesEntry
public SetQueueAttributesRequest addAttributesEntry(String key, String value)
-
clearAttributesEntries
public SetQueueAttributesRequest clearAttributesEntries()
Removes all the entries added into Attributes. <p> Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public SetQueueAttributesRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-