public class SendMessageRequest extends AmazonWebServiceRequest implements java.io.Serializable
Delivers a message to the specified queue.
The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:
#x9
| #xA
| #xD
| [#x20
to #xD7FF
] | [#xE000
to #xFFFD
] | [
#x10000
to #x10FFFF
]
For more information, see RFC1321. If you send any characters that aren't included in this list, your request will be rejected.
Constructor and Description |
---|
SendMessageRequest()
Default constructor for SendMessageRequest object.
|
SendMessageRequest(java.lang.String queueUrl,
java.lang.String messageBody)
Constructs a new SendMessageRequest object.
|
Modifier and Type | Method and Description |
---|---|
SendMessageRequest |
addMessageAttributesEntry(java.lang.String key,
MessageAttributeValue value)
Each message attribute consists of a Name, Type, and Value.
|
SendMessageRequest |
clearMessageAttributesEntries()
Removes all the entries added into MessageAttributes.
|
boolean |
equals(java.lang.Object obj) |
java.lang.Integer |
getDelaySeconds()
The number of seconds (0 to 900 - 15 minutes) to delay a specific
message.
|
java.util.Map<java.lang.String,MessageAttributeValue> |
getMessageAttributes()
Each message attribute consists of a Name, Type, and Value.
|
java.lang.String |
getMessageBody()
The message to send.
|
java.lang.String |
getMessageDeduplicationId()
This parameter applies only to FIFO (first-in-first-out) queues.
|
java.lang.String |
getMessageGroupId()
This parameter applies only to FIFO (first-in-first-out) queues.
|
java.lang.String |
getQueueUrl()
The URL of the Amazon SQS queue to take action on.
|
int |
hashCode() |
void |
setDelaySeconds(java.lang.Integer delaySeconds)
The number of seconds (0 to 900 - 15 minutes) to delay a specific
message.
|
void |
setMessageAttributes(java.util.Map<java.lang.String,MessageAttributeValue> messageAttributes)
Each message attribute consists of a Name, Type, and Value.
|
void |
setMessageBody(java.lang.String messageBody)
The message to send.
|
void |
setMessageDeduplicationId(java.lang.String messageDeduplicationId)
This parameter applies only to FIFO (first-in-first-out) queues.
|
void |
setMessageGroupId(java.lang.String messageGroupId)
This parameter applies only to FIFO (first-in-first-out) queues.
|
void |
setQueueUrl(java.lang.String queueUrl)
The URL of the Amazon SQS queue to take action on.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
SendMessageRequest |
withDelaySeconds(java.lang.Integer delaySeconds)
The number of seconds (0 to 900 - 15 minutes) to delay a specific
message.
|
SendMessageRequest |
withMessageAttributes(java.util.Map<java.lang.String,MessageAttributeValue> messageAttributes)
Each message attribute consists of a Name, Type, and Value.
|
SendMessageRequest |
withMessageBody(java.lang.String messageBody)
The message to send.
|
SendMessageRequest |
withMessageDeduplicationId(java.lang.String messageDeduplicationId)
This parameter applies only to FIFO (first-in-first-out) queues.
|
SendMessageRequest |
withMessageGroupId(java.lang.String messageGroupId)
This parameter applies only to FIFO (first-in-first-out) queues.
|
SendMessageRequest |
withQueueUrl(java.lang.String queueUrl)
The URL of the Amazon SQS queue to take action on.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public SendMessageRequest()
public SendMessageRequest(java.lang.String queueUrl, java.lang.String messageBody)
queueUrl
- The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
messageBody
- The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding note.
public java.lang.String getQueueUrl()
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
public void setQueueUrl(java.lang.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 SendMessageRequest withQueueUrl(java.lang.String queueUrl)
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
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.
Queue URLs are case-sensitive.
public java.lang.String getMessageBody()
The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding note.
The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding note.
public void setMessageBody(java.lang.String messageBody)
The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding note.
messageBody
- The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding note.
public SendMessageRequest withMessageBody(java.lang.String messageBody)
The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding note.
Returns a reference to this object so that method calls can be chained together.
messageBody
- The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding note.
public java.lang.Integer getDelaySeconds()
The number of seconds (0 to 900 - 15 minutes) to delay a specific
message. Messages with a positive DelaySeconds
value become
available for processing after the delay time 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.
The number of seconds (0 to 900 - 15 minutes) to delay a specific
message. Messages with a positive DelaySeconds
value
become available for processing after the delay time 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 void setDelaySeconds(java.lang.Integer delaySeconds)
The number of seconds (0 to 900 - 15 minutes) to delay a specific
message. Messages with a positive DelaySeconds
value become
available for processing after the delay time 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 number of seconds (0 to 900 - 15 minutes) to delay a
specific message. Messages with a positive
DelaySeconds
value become available for
processing after the delay time 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(java.lang.Integer delaySeconds)
The number of seconds (0 to 900 - 15 minutes) to delay a specific
message. Messages with a positive DelaySeconds
value become
available for processing after the delay time 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.
Returns a reference to this object so that method calls can be chained together.
delaySeconds
-
The number of seconds (0 to 900 - 15 minutes) to delay a
specific message. Messages with a positive
DelaySeconds
value become available for
processing after the delay time 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 java.util.Map<java.lang.String,MessageAttributeValue> getMessageAttributes()
Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items in the Amazon SQS Developer Guide.
Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items in the Amazon SQS Developer Guide.
public void setMessageAttributes(java.util.Map<java.lang.String,MessageAttributeValue> messageAttributes)
Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items in the Amazon SQS Developer Guide.
messageAttributes
- Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items in the Amazon SQS Developer Guide.
public SendMessageRequest withMessageAttributes(java.util.Map<java.lang.String,MessageAttributeValue> messageAttributes)
Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items in the Amazon SQS Developer Guide.
Returns a reference to this object so that method calls can be chained together.
messageAttributes
- Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items in the Amazon SQS Developer Guide.
public SendMessageRequest addMessageAttributesEntry(java.lang.String key, MessageAttributeValue value)
Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items in the Amazon SQS Developer Guide.
The method adds a new key-value pair into MessageAttributes parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into MessageAttributes.value
- The corresponding value of the entry to be added into
MessageAttributes.public SendMessageRequest clearMessageAttributesEntries()
Returns a reference to this object so that method calls can be chained together.
public java.lang.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.
You can also use ContentBasedDeduplication
for messages with
identical content to be treated as duplicates.
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 recipient of
the message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgdment is lost and the
message is resent with the same MessageDeduplicationId
after
the deduplication interval, Amazon SQS can't detect duplicate messages.
The 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 Simple
Queue Service Developer Guide.
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.
You can also use ContentBasedDeduplication
for
messages with identical content to be treated as duplicates.
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
recipient of the message (this can be useful for troubleshooting
delivery issues).
If a message is sent successfully but the acknowledgdment is lost
and the message is resent with the same
MessageDeduplicationId
after the deduplication
interval, Amazon SQS can't detect duplicate messages.
The 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
Simple Queue Service Developer Guide.
public void setMessageDeduplicationId(java.lang.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.
You can also use ContentBasedDeduplication
for messages with
identical content to be treated as duplicates.
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 recipient of
the message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgdment is lost and the
message is resent with the same MessageDeduplicationId
after
the deduplication interval, Amazon SQS can't detect duplicate messages.
The 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 Simple
Queue Service 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.
You can also use ContentBasedDeduplication
for
messages with identical content to be treated as duplicates.
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
recipient of the message (this can be useful for
troubleshooting delivery issues).
If a message is sent successfully but the acknowledgdment is
lost and the message is resent with the same
MessageDeduplicationId
after the deduplication
interval, Amazon SQS can't detect duplicate messages.
The 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 Simple Queue Service Developer Guide.
public SendMessageRequest withMessageDeduplicationId(java.lang.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.
You can also use ContentBasedDeduplication
for messages with
identical content to be treated as duplicates.
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 recipient of
the message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgdment is lost and the
message is resent with the same MessageDeduplicationId
after
the deduplication interval, Amazon SQS can't detect duplicate messages.
The 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 Simple
Queue Service Developer Guide.
Returns a reference to this object so that method calls can be chained together.
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.
You can also use ContentBasedDeduplication
for
messages with identical content to be treated as duplicates.
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
recipient of the message (this can be useful for
troubleshooting delivery issues).
If a message is sent successfully but the acknowledgdment is
lost and the message is resent with the same
MessageDeduplicationId
after the deduplication
interval, Amazon SQS can't detect duplicate messages.
The 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 Simple Queue Service Developer Guide.
public java.lang.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 readers 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 length of MessageGroupId
is 128 characters. Valid values
are alphanumeric characters and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon Simple Queue
Service Developer Guide.
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 readers 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 length of MessageGroupId
is 128 characters.
Valid values are alphanumeric characters and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon Simple
Queue Service Developer Guide.
public void setMessageGroupId(java.lang.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 readers 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 length of MessageGroupId
is 128 characters. Valid values
are alphanumeric characters and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon Simple Queue
Service Developer Guide.
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 readers 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 length of MessageGroupId
is 128 characters.
Valid values are alphanumeric characters and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
For best practices of using MessageGroupId
, see
Using the MessageGroupId Property in the Amazon Simple
Queue Service Developer Guide.
public SendMessageRequest withMessageGroupId(java.lang.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 readers 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 length of MessageGroupId
is 128 characters. Valid values
are alphanumeric characters and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon Simple Queue
Service Developer Guide.
Returns a reference to this object so that method calls can be chained together.
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 readers 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 length of MessageGroupId
is 128 characters.
Valid values are alphanumeric characters and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
For best practices of using MessageGroupId
, see
Using the MessageGroupId Property in the Amazon Simple
Queue Service Developer Guide.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.