@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SendMessageRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
SendMessageRequest()
Default constructor for SendMessageRequest object.
|
SendMessageRequest(String queueUrl,
String messageBody)
Constructs a new SendMessageRequest object.
|
Modifier and Type | Method and Description |
---|---|
SendMessageRequest |
addMessageAttributesEntry(String key,
MessageAttributeValue value)
Add a single MessageAttributes entry
|
SendMessageRequest |
addMessageSystemAttributesEntry(String key,
MessageSystemAttributeValue value)
Add a single MessageSystemAttributes entry
|
SendMessageRequest |
clearMessageAttributesEntries()
Removes all the entries added into MessageAttributes.
|
SendMessageRequest |
clearMessageSystemAttributesEntries()
Removes all the entries added into MessageSystemAttributes.
|
SendMessageRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Integer |
getDelaySeconds()
The length of time, in seconds, for which to delay a specific message.
|
Map<String,MessageAttributeValue> |
getMessageAttributes()
Each message attribute consists of a
Name , Type , and Value . |
String |
getMessageBody()
The message to send.
|
String |
getMessageDeduplicationId()
This parameter applies only to FIFO (first-in-first-out) queues.
|
String |
getMessageGroupId()
This parameter applies only to FIFO (first-in-first-out) queues.
|
Map<String,MessageSystemAttributeValue> |
getMessageSystemAttributes()
The message system attribute to send.
|
String |
getQueueUrl()
The URL of the Amazon SQS queue to which a message is sent.
|
int |
hashCode() |
void |
setDelaySeconds(Integer delaySeconds)
The length of time, in seconds, for which to delay a specific message.
|
void |
setMessageAttributes(Map<String,MessageAttributeValue> messageAttributes)
Each message attribute consists of a
Name , Type , and Value . |
void |
setMessageBody(String messageBody)
The message to send.
|
void |
setMessageDeduplicationId(String messageDeduplicationId)
This parameter applies only to FIFO (first-in-first-out) queues.
|
void |
setMessageGroupId(String messageGroupId)
This parameter applies only to FIFO (first-in-first-out) queues.
|
void |
setMessageSystemAttributes(Map<String,MessageSystemAttributeValue> messageSystemAttributes)
The message system attribute to send.
|
void |
setQueueUrl(String queueUrl)
The URL of the Amazon SQS queue to which a message is sent.
|
String |
toString()
Returns a string representation of this object.
|
SendMessageRequest |
withDelaySeconds(Integer delaySeconds)
The length of time, in seconds, for which to delay a specific message.
|
SendMessageRequest |
withMessageAttributes(Map<String,MessageAttributeValue> messageAttributes)
Each message attribute consists of a
Name , Type , and Value . |
SendMessageRequest |
withMessageBody(String messageBody)
The message to send.
|
SendMessageRequest |
withMessageDeduplicationId(String messageDeduplicationId)
This parameter applies only to FIFO (first-in-first-out) queues.
|
SendMessageRequest |
withMessageGroupId(String messageGroupId)
This parameter applies only to FIFO (first-in-first-out) queues.
|
SendMessageRequest |
withMessageSystemAttributes(Map<String,MessageSystemAttributeValue> messageSystemAttributes)
The message system attribute to send.
|
SendMessageRequest |
withQueueUrl(String queueUrl)
The URL of the Amazon SQS queue to which a message is sent.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public SendMessageRequest()
public SendMessageRequest(String queueUrl, String messageBody)
queueUrl
- The URL of the Amazon SQS queue to which a message is sent.
Queue URLs and names are case-sensitive.
messageBody
- The message to send. The minimum size is one character. The maximum size is 256 KiB.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
#x9
| #xA
| #xD
| #x20
to #xD7FF
|
#xE000
to #xFFFD
| #x10000
to #x10FFFF
Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters.
Instead, it replaces those invalid characters with U+FFFD
before storing the message in the
queue, as long as the message body contains at least one valid character.
public void setQueueUrl(String queueUrl)
The URL of the Amazon SQS queue to which a message is sent.
Queue URLs and names are case-sensitive.
queueUrl
- The URL of the Amazon SQS queue to which a message is sent.
Queue URLs and names are case-sensitive.
public String getQueueUrl()
The URL of the Amazon SQS queue to which a message is sent.
Queue URLs and names are case-sensitive.
Queue URLs and names are case-sensitive.
public SendMessageRequest withQueueUrl(String queueUrl)
The URL of the Amazon SQS queue to which a message is sent.
Queue URLs and names are case-sensitive.
queueUrl
- The URL of the Amazon SQS queue to which a message is sent.
Queue URLs and names are case-sensitive.
public void setMessageBody(String messageBody)
The message to send. The minimum size is one character. The maximum size is 256 KiB.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
#x9
| #xA
| #xD
| #x20
to #xD7FF
|
#xE000
to #xFFFD
| #x10000
to #x10FFFF
Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters.
Instead, it replaces those invalid characters with U+FFFD
before storing the message in the queue,
as long as the message body contains at least one valid character.
messageBody
- The message to send. The minimum size is one character. The maximum size is 256 KiB. A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
#x9
| #xA
| #xD
| #x20
to #xD7FF
|
#xE000
to #xFFFD
| #x10000
to #x10FFFF
Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters.
Instead, it replaces those invalid characters with U+FFFD
before storing the message in the
queue, as long as the message body contains at least one valid character.
public String getMessageBody()
The message to send. The minimum size is one character. The maximum size is 256 KiB.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
#x9
| #xA
| #xD
| #x20
to #xD7FF
|
#xE000
to #xFFFD
| #x10000
to #x10FFFF
Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters.
Instead, it replaces those invalid characters with U+FFFD
before storing the message in the queue,
as long as the message body contains at least one valid character.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
#x9
| #xA
| #xD
| #x20
to #xD7FF
|
#xE000
to #xFFFD
| #x10000
to #x10FFFF
Amazon SQS does not throw an exception or completely reject the message if it contains invalid
characters. Instead, it replaces those invalid characters with U+FFFD
before storing the
message in the queue, as long as the message body contains at least one valid character.
public SendMessageRequest withMessageBody(String messageBody)
The message to send. The minimum size is one character. The maximum size is 256 KiB.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
#x9
| #xA
| #xD
| #x20
to #xD7FF
|
#xE000
to #xFFFD
| #x10000
to #x10FFFF
Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters.
Instead, it replaces those invalid characters with U+FFFD
before storing the message in the queue,
as long as the message body contains at least one valid character.
messageBody
- The message to send. The minimum size is one character. The maximum size is 256 KiB. A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
#x9
| #xA
| #xD
| #x20
to #xD7FF
|
#xE000
to #xFFFD
| #x10000
to #x10FFFF
Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters.
Instead, it replaces those invalid characters with U+FFFD
before storing the message in the
queue, as long as the message body contains at least one valid character.
public void setDelaySeconds(Integer delaySeconds)
The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15
minutes. Messages with a positive DelaySeconds
value become available for processing after the delay
period is finished. If you don't specify a value, the default value for the queue applies.
When you set FifoQueue
, you can't set DelaySeconds
per message. You can set this
parameter only on a queue level.
delaySeconds
- The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15
minutes. Messages with a positive DelaySeconds
value become available for processing after
the delay period is finished. If you don't specify a value, the default value for the queue applies.
When you set FifoQueue
, you can't set DelaySeconds
per message. You can set this
parameter only on a queue level.
public Integer getDelaySeconds()
The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15
minutes. Messages with a positive DelaySeconds
value become available for processing after the delay
period is finished. If you don't specify a value, the default value for the queue applies.
When you set FifoQueue
, you can't set DelaySeconds
per message. You can set this
parameter only on a queue level.
DelaySeconds
value become available for processing
after the delay period is finished. If you don't specify a value, the default value for the queue
applies.
When you set FifoQueue
, you can't set DelaySeconds
per message. You can set
this parameter only on a queue level.
public SendMessageRequest withDelaySeconds(Integer delaySeconds)
The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15
minutes. Messages with a positive DelaySeconds
value become available for processing after the delay
period is finished. If you don't specify a value, the default value for the queue applies.
When you set FifoQueue
, you can't set DelaySeconds
per message. You can set this
parameter only on a queue level.
delaySeconds
- The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15
minutes. Messages with a positive DelaySeconds
value become available for processing after
the delay period is finished. If you don't specify a value, the default value for the queue applies.
When you set FifoQueue
, you can't set DelaySeconds
per message. You can set this
parameter only on a queue level.
public Map<String,MessageAttributeValue> getMessageAttributes()
Each message attribute consists of a Name
, Type
, and Value
. For more
information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.
Name
, Type
, and Value
. For
more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.public void setMessageAttributes(Map<String,MessageAttributeValue> messageAttributes)
Each message attribute consists of a Name
, Type
, and Value
. For more
information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.
messageAttributes
- Each message attribute consists of a Name
, Type
, and Value
. For
more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.public SendMessageRequest withMessageAttributes(Map<String,MessageAttributeValue> messageAttributes)
Each message attribute consists of a Name
, Type
, and Value
. For more
information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.
messageAttributes
- Each message attribute consists of a Name
, Type
, and Value
. For
more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.public SendMessageRequest addMessageAttributesEntry(String key, MessageAttributeValue value)
public SendMessageRequest clearMessageAttributesEntries()
public Map<String,MessageSystemAttributeValue> getMessageSystemAttributes()
The message system attribute to send. Each message system attribute consists of a Name
,
Type
, and Value
.
Currently, the only supported message system attribute is AWSTraceHeader
. Its type must be
String
and its value must be a correctly formatted X-Ray trace header string.
The size of a message system attribute doesn't count towards the total size of a message.
Name
,
Type
, and Value
.
Currently, the only supported message system attribute is AWSTraceHeader
. Its type must be
String
and its value must be a correctly formatted X-Ray trace header string.
The size of a message system attribute doesn't count towards the total size of a message.
public void setMessageSystemAttributes(Map<String,MessageSystemAttributeValue> messageSystemAttributes)
The message system attribute to send. Each message system attribute consists of a Name
,
Type
, and Value
.
Currently, the only supported message system attribute is AWSTraceHeader
. Its type must be
String
and its value must be a correctly formatted X-Ray trace header string.
The size of a message system attribute doesn't count towards the total size of a message.
messageSystemAttributes
- The message system attribute to send. Each message system attribute consists of a Name
,
Type
, and Value
.
Currently, the only supported message system attribute is AWSTraceHeader
. Its type must be
String
and its value must be a correctly formatted X-Ray trace header string.
The size of a message system attribute doesn't count towards the total size of a message.
public SendMessageRequest withMessageSystemAttributes(Map<String,MessageSystemAttributeValue> messageSystemAttributes)
The message system attribute to send. Each message system attribute consists of a Name
,
Type
, and Value
.
Currently, the only supported message system attribute is AWSTraceHeader
. Its type must be
String
and its value must be a correctly formatted X-Ray trace header string.
The size of a message system attribute doesn't count towards the total size of a message.
messageSystemAttributes
- The message system attribute to send. Each message system attribute consists of a Name
,
Type
, and Value
.
Currently, the only supported message system attribute is AWSTraceHeader
. Its type must be
String
and its value must be a correctly formatted X-Ray trace header string.
The size of a message system attribute doesn't count towards the total size of a message.
public SendMessageRequest addMessageSystemAttributesEntry(String key, MessageSystemAttributeValue value)
public SendMessageRequest clearMessageSystemAttributesEntries()
public void setMessageDeduplicationId(String messageDeduplicationId)
This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of sent messages. If a message with a particular
MessageDeduplicationId
is sent successfully, any messages sent with the same
MessageDeduplicationId
are accepted successfully but aren't delivered during the 5-minute
deduplication interval. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.
Every message must have a unique MessageDeduplicationId
,
You may provide a MessageDeduplicationId
explicitly.
If you aren't able to provide a MessageDeduplicationId
and you enable
ContentBasedDeduplication
for your queue, Amazon SQS uses a SHA-256 hash to generate the
MessageDeduplicationId
using the body of the message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and the queue doesn't have
ContentBasedDeduplication
set, the action fails with an error.
If the queue has ContentBasedDeduplication
set, your MessageDeduplicationId
overrides
the generated one.
When ContentBasedDeduplication
is in effect, messages with identical content sent within the
deduplication interval are treated as duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication
enabled and then another message with a
MessageDeduplicationId
that is the same as the one generated for the first
MessageDeduplicationId
, the two messages are treated as duplicates and only one copy of the message
is delivered.
The MessageDeduplicationId
is available to the consumer of the message (this can be useful for
troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same
MessageDeduplicationId
after the deduplication interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
The maximum length of MessageDeduplicationId
is 128 characters. MessageDeduplicationId
can contain alphanumeric characters (a-z
, A-Z
, 0-9
) and punctuation (
!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
).
For best practices of using MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS Developer Guide.
messageDeduplicationId
- This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of sent messages. If a message with a particular
MessageDeduplicationId
is sent successfully, any messages sent with the same
MessageDeduplicationId
are accepted successfully but aren't delivered during the 5-minute
deduplication interval. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.
Every message must have a unique MessageDeduplicationId
,
You may provide a MessageDeduplicationId
explicitly.
If you aren't able to provide a MessageDeduplicationId
and you enable
ContentBasedDeduplication
for your queue, Amazon SQS uses a SHA-256 hash to generate the
MessageDeduplicationId
using the body of the message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and the queue doesn't have
ContentBasedDeduplication
set, the action fails with an error.
If the queue has ContentBasedDeduplication
set, your MessageDeduplicationId
overrides the generated one.
When ContentBasedDeduplication
is in effect, messages with identical content sent within the
deduplication interval are treated as duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication
enabled and then another message with
a MessageDeduplicationId
that is the same as the one generated for the first
MessageDeduplicationId
, the two messages are treated as duplicates and only one copy of the
message is delivered.
The MessageDeduplicationId
is available to the consumer of the message (this can be useful
for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same
MessageDeduplicationId
after the deduplication interval, Amazon SQS can't detect duplicate
messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
The maximum length of MessageDeduplicationId
is 128 characters.
MessageDeduplicationId
can contain alphanumeric characters (a-z
,
A-Z
, 0-9
) and punctuation (
!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
).
For best practices of using MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS Developer Guide.
public String getMessageDeduplicationId()
This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of sent messages. If a message with a particular
MessageDeduplicationId
is sent successfully, any messages sent with the same
MessageDeduplicationId
are accepted successfully but aren't delivered during the 5-minute
deduplication interval. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.
Every message must have a unique MessageDeduplicationId
,
You may provide a MessageDeduplicationId
explicitly.
If you aren't able to provide a MessageDeduplicationId
and you enable
ContentBasedDeduplication
for your queue, Amazon SQS uses a SHA-256 hash to generate the
MessageDeduplicationId
using the body of the message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and the queue doesn't have
ContentBasedDeduplication
set, the action fails with an error.
If the queue has ContentBasedDeduplication
set, your MessageDeduplicationId
overrides
the generated one.
When ContentBasedDeduplication
is in effect, messages with identical content sent within the
deduplication interval are treated as duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication
enabled and then another message with a
MessageDeduplicationId
that is the same as the one generated for the first
MessageDeduplicationId
, the two messages are treated as duplicates and only one copy of the message
is delivered.
The MessageDeduplicationId
is available to the consumer of the message (this can be useful for
troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same
MessageDeduplicationId
after the deduplication interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
The maximum length of MessageDeduplicationId
is 128 characters. MessageDeduplicationId
can contain alphanumeric characters (a-z
, A-Z
, 0-9
) and punctuation (
!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
).
For best practices of using MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS Developer Guide.
The token used for deduplication of sent messages. If a message with a particular
MessageDeduplicationId
is sent successfully, any messages sent with the same
MessageDeduplicationId
are accepted successfully but aren't delivered during the 5-minute
deduplication interval. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.
Every message must have a unique MessageDeduplicationId
,
You may provide a MessageDeduplicationId
explicitly.
If you aren't able to provide a MessageDeduplicationId
and you enable
ContentBasedDeduplication
for your queue, Amazon SQS uses a SHA-256 hash to generate the
MessageDeduplicationId
using the body of the message (but not the attributes of the
message).
If you don't provide a MessageDeduplicationId
and the queue doesn't have
ContentBasedDeduplication
set, the action fails with an error.
If the queue has ContentBasedDeduplication
set, your MessageDeduplicationId
overrides the generated one.
When ContentBasedDeduplication
is in effect, messages with identical content sent within the
deduplication interval are treated as duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication
enabled and then another message with
a MessageDeduplicationId
that is the same as the one generated for the first
MessageDeduplicationId
, the two messages are treated as duplicates and only one copy of the
message is delivered.
The MessageDeduplicationId
is available to the consumer of the message (this can be useful
for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same
MessageDeduplicationId
after the deduplication interval, Amazon SQS can't detect duplicate
messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
The maximum length of MessageDeduplicationId
is 128 characters.
MessageDeduplicationId
can contain alphanumeric characters (a-z
,
A-Z
, 0-9
) and punctuation (
!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
).
For best practices of using MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS Developer Guide.
public SendMessageRequest withMessageDeduplicationId(String messageDeduplicationId)
This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of sent messages. If a message with a particular
MessageDeduplicationId
is sent successfully, any messages sent with the same
MessageDeduplicationId
are accepted successfully but aren't delivered during the 5-minute
deduplication interval. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.
Every message must have a unique MessageDeduplicationId
,
You may provide a MessageDeduplicationId
explicitly.
If you aren't able to provide a MessageDeduplicationId
and you enable
ContentBasedDeduplication
for your queue, Amazon SQS uses a SHA-256 hash to generate the
MessageDeduplicationId
using the body of the message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and the queue doesn't have
ContentBasedDeduplication
set, the action fails with an error.
If the queue has ContentBasedDeduplication
set, your MessageDeduplicationId
overrides
the generated one.
When ContentBasedDeduplication
is in effect, messages with identical content sent within the
deduplication interval are treated as duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication
enabled and then another message with a
MessageDeduplicationId
that is the same as the one generated for the first
MessageDeduplicationId
, the two messages are treated as duplicates and only one copy of the message
is delivered.
The MessageDeduplicationId
is available to the consumer of the message (this can be useful for
troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same
MessageDeduplicationId
after the deduplication interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
The maximum length of MessageDeduplicationId
is 128 characters. MessageDeduplicationId
can contain alphanumeric characters (a-z
, A-Z
, 0-9
) and punctuation (
!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
).
For best practices of using MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS Developer Guide.
messageDeduplicationId
- This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of sent messages. If a message with a particular
MessageDeduplicationId
is sent successfully, any messages sent with the same
MessageDeduplicationId
are accepted successfully but aren't delivered during the 5-minute
deduplication interval. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.
Every message must have a unique MessageDeduplicationId
,
You may provide a MessageDeduplicationId
explicitly.
If you aren't able to provide a MessageDeduplicationId
and you enable
ContentBasedDeduplication
for your queue, Amazon SQS uses a SHA-256 hash to generate the
MessageDeduplicationId
using the body of the message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and the queue doesn't have
ContentBasedDeduplication
set, the action fails with an error.
If the queue has ContentBasedDeduplication
set, your MessageDeduplicationId
overrides the generated one.
When ContentBasedDeduplication
is in effect, messages with identical content sent within the
deduplication interval are treated as duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication
enabled and then another message with
a MessageDeduplicationId
that is the same as the one generated for the first
MessageDeduplicationId
, the two messages are treated as duplicates and only one copy of the
message is delivered.
The MessageDeduplicationId
is available to the consumer of the message (this can be useful
for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same
MessageDeduplicationId
after the deduplication interval, Amazon SQS can't detect duplicate
messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
The maximum length of MessageDeduplicationId
is 128 characters.
MessageDeduplicationId
can contain alphanumeric characters (a-z
,
A-Z
, 0-9
) and punctuation (
!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
).
For best practices of using MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS Developer Guide.
public void setMessageGroupId(String messageGroupId)
This parameter applies only to FIFO (first-in-first-out) queues.
The tag that specifies that a message belongs to a specific message group. Messages that belong to the same
message group are processed in a FIFO manner (however, messages in different message groups might be processed
out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId
values (for example, session data for multiple users). In this scenario, multiple consumers can process the
queue, but the session data of each user is processed in a FIFO fashion.
You must associate a non-empty MessageGroupId
with a message. If you don't provide a
MessageGroupId
, the action fails.
ReceiveMessage
might return messages with multiple MessageGroupId
values. For each
MessageGroupId
, the messages are sorted by time sent. The caller can't specify a
MessageGroupId
.
The maximum length of MessageGroupId
is 128 characters. Valid values: alphanumeric characters and
punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon SQS Developer Guide.
MessageGroupId
is required for FIFO queues. You can't use it for Standard queues.
messageGroupId
- This parameter applies only to FIFO (first-in-first-out) queues.
The tag that specifies that a message belongs to a specific message group. Messages that belong to the
same message group are processed in a FIFO manner (however, messages in different message groups might be
processed out of order). To interleave multiple ordered streams within a single queue, use
MessageGroupId
values (for example, session data for multiple users). In this scenario,
multiple consumers can process the queue, but the session data of each user is processed in a FIFO
fashion.
You must associate a non-empty MessageGroupId
with a message. If you don't provide a
MessageGroupId
, the action fails.
ReceiveMessage
might return messages with multiple MessageGroupId
values. For
each MessageGroupId
, the messages are sorted by time sent. The caller can't specify a
MessageGroupId
.
The maximum length of MessageGroupId
is 128 characters. Valid values: alphanumeric characters
and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon SQS Developer Guide.
MessageGroupId
is required for FIFO queues. You can't use it for Standard queues.
public String getMessageGroupId()
This parameter applies only to FIFO (first-in-first-out) queues.
The tag that specifies that a message belongs to a specific message group. Messages that belong to the same
message group are processed in a FIFO manner (however, messages in different message groups might be processed
out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId
values (for example, session data for multiple users). In this scenario, multiple consumers can process the
queue, but the session data of each user is processed in a FIFO fashion.
You must associate a non-empty MessageGroupId
with a message. If you don't provide a
MessageGroupId
, the action fails.
ReceiveMessage
might return messages with multiple MessageGroupId
values. For each
MessageGroupId
, the messages are sorted by time sent. The caller can't specify a
MessageGroupId
.
The maximum length of MessageGroupId
is 128 characters. Valid values: alphanumeric characters and
punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon SQS Developer Guide.
MessageGroupId
is required for FIFO queues. You can't use it for Standard queues.
The tag that specifies that a message belongs to a specific message group. Messages that belong to the
same message group are processed in a FIFO manner (however, messages in different message groups might be
processed out of order). To interleave multiple ordered streams within a single queue, use
MessageGroupId
values (for example, session data for multiple users). In this scenario,
multiple consumers can process the queue, but the session data of each user is processed in a FIFO
fashion.
You must associate a non-empty MessageGroupId
with a message. If you don't provide a
MessageGroupId
, the action fails.
ReceiveMessage
might return messages with multiple MessageGroupId
values. For
each MessageGroupId
, the messages are sorted by time sent. The caller can't specify a
MessageGroupId
.
The maximum length of MessageGroupId
is 128 characters. Valid values: alphanumeric
characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon SQS Developer Guide.
MessageGroupId
is required for FIFO queues. You can't use it for Standard queues.
public SendMessageRequest withMessageGroupId(String messageGroupId)
This parameter applies only to FIFO (first-in-first-out) queues.
The tag that specifies that a message belongs to a specific message group. Messages that belong to the same
message group are processed in a FIFO manner (however, messages in different message groups might be processed
out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId
values (for example, session data for multiple users). In this scenario, multiple consumers can process the
queue, but the session data of each user is processed in a FIFO fashion.
You must associate a non-empty MessageGroupId
with a message. If you don't provide a
MessageGroupId
, the action fails.
ReceiveMessage
might return messages with multiple MessageGroupId
values. For each
MessageGroupId
, the messages are sorted by time sent. The caller can't specify a
MessageGroupId
.
The maximum length of MessageGroupId
is 128 characters. Valid values: alphanumeric characters and
punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon SQS Developer Guide.
MessageGroupId
is required for FIFO queues. You can't use it for Standard queues.
messageGroupId
- This parameter applies only to FIFO (first-in-first-out) queues.
The tag that specifies that a message belongs to a specific message group. Messages that belong to the
same message group are processed in a FIFO manner (however, messages in different message groups might be
processed out of order). To interleave multiple ordered streams within a single queue, use
MessageGroupId
values (for example, session data for multiple users). In this scenario,
multiple consumers can process the queue, but the session data of each user is processed in a FIFO
fashion.
You must associate a non-empty MessageGroupId
with a message. If you don't provide a
MessageGroupId
, the action fails.
ReceiveMessage
might return messages with multiple MessageGroupId
values. For
each MessageGroupId
, the messages are sorted by time sent. The caller can't specify a
MessageGroupId
.
The maximum length of MessageGroupId
is 128 characters. Valid values: alphanumeric characters
and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon SQS Developer Guide.
MessageGroupId
is required for FIFO queues. You can't use it for Standard queues.
public String toString()
toString
in class Object
Object.toString()
public SendMessageRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()