public class SetQueueAttributesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
SetQueueAttributesRequest()
Default constructor for SetQueueAttributesRequest object.
|
SetQueueAttributesRequest(String queueUrl,
Map<String,String> attributes)
Constructs a new SetQueueAttributesRequest object.
|
Modifier and Type | Method and Description |
---|---|
SetQueueAttributesRequest |
addAttributesEntry(String key,
String value) |
SetQueueAttributesRequest |
clearAttributesEntries()
Removes all the entries added into Attributes.
|
SetQueueAttributesRequest |
clone() |
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.
|
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 SetQueueAttributesRequest()
public SetQueueAttributesRequest(String queueUrl, Map<String,String> attributes)
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
, and QueueArn
) will be ignored.
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 SetQueueAttributesRequest 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 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
, and QueueArn
) will be ignored.
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
, and QueueArn
) will be ignored.
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
, and QueueArn
) will be ignored.
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
, and QueueArn
) will be ignored.
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
, and QueueArn
) will be ignored.
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
, and QueueArn
) will be ignored.
public SetQueueAttributesRequest addAttributesEntry(String key, String value)
public SetQueueAttributesRequest clearAttributesEntries()
public String toString()
toString
in class Object
Object.toString()
public SetQueueAttributesRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2016. All rights reserved.