Interface SendMessageBatchRequestEntry.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<SendMessageBatchRequestEntry.Builder,SendMessageBatchRequestEntry>
,SdkBuilder<SendMessageBatchRequestEntry.Builder,SendMessageBatchRequestEntry>
,SdkPojo
- Enclosing class:
- SendMessageBatchRequestEntry
public static interface SendMessageBatchRequestEntry.Builder extends SdkPojo, CopyableBuilder<SendMessageBatchRequestEntry.Builder,SendMessageBatchRequestEntry>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description SendMessageBatchRequestEntry.Builder
delaySeconds(Integer delaySeconds)
The length of time, in seconds, for which a specific message is delayed.SendMessageBatchRequestEntry.Builder
id(String id)
An identifier for a message in this batch used to communicate the result.SendMessageBatchRequestEntry.Builder
messageAttributes(Map<String,MessageAttributeValue> messageAttributes)
Each message attribute consists of aName
,Type
, andValue
.SendMessageBatchRequestEntry.Builder
messageBody(String messageBody)
The body of the message.SendMessageBatchRequestEntry.Builder
messageDeduplicationId(String messageDeduplicationId)
This parameter applies only to FIFO (first-in-first-out) queues.SendMessageBatchRequestEntry.Builder
messageGroupId(String messageGroupId)
This parameter applies only to FIFO (first-in-first-out) queues.SendMessageBatchRequestEntry.Builder
messageSystemAttributes(Map<MessageSystemAttributeNameForSends,MessageSystemAttributeValue> messageSystemAttributes)
The message system attribute to send Each message system attribute consists of aName
,Type
, andValue
.SendMessageBatchRequestEntry.Builder
messageSystemAttributesWithStrings(Map<String,MessageSystemAttributeValue> messageSystemAttributes)
The message system attribute to send Each message system attribute consists of aName
,Type
, andValue
.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
id
SendMessageBatchRequestEntry.Builder id(String id)
An identifier for a message in this batch used to communicate the result.
The
Id
s of a batch request need to be unique within a request.This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
- Parameters:
id
- An identifier for a message in this batch used to communicate the result.The
Id
s of a batch request need to be unique within a request.This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
messageBody
SendMessageBatchRequestEntry.Builder messageBody(String messageBody)
The body of the message.
- Parameters:
messageBody
- The body of the message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
delaySeconds
SendMessageBatchRequestEntry.Builder delaySeconds(Integer delaySeconds)
The length of time, in seconds, for which a specific message is delayed. 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 is applied.When you set
FifoQueue
, you can't setDelaySeconds
per message. You can set this parameter only on a queue level.- Parameters:
delaySeconds
- The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positiveDelaySeconds
value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue is applied.When you set
FifoQueue
, you can't setDelaySeconds
per message. You can set this parameter only on a queue level.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
messageAttributes
SendMessageBatchRequestEntry.Builder messageAttributes(Map<String,MessageAttributeValue> messageAttributes)
Each message attribute consists of a
Name
,Type
, andValue
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.- Parameters:
messageAttributes
- Each message attribute consists of aName
,Type
, andValue
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
messageSystemAttributesWithStrings
SendMessageBatchRequestEntry.Builder messageSystemAttributesWithStrings(Map<String,MessageSystemAttributeValue> messageSystemAttributes)
The message system attribute to send Each message system attribute consists of a
Name
,Type
, andValue
.-
Currently, the only supported message system attribute is
AWSTraceHeader
. Its type must beString
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.
- Parameters:
messageSystemAttributes
- The message system attribute to send Each message system attribute consists of aName
,Type
, andValue
.-
Currently, the only supported message system attribute is
AWSTraceHeader
. Its type must beString
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
messageSystemAttributes
SendMessageBatchRequestEntry.Builder messageSystemAttributes(Map<MessageSystemAttributeNameForSends,MessageSystemAttributeValue> messageSystemAttributes)
The message system attribute to send Each message system attribute consists of a
Name
,Type
, andValue
.-
Currently, the only supported message system attribute is
AWSTraceHeader
. Its type must beString
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.
- Parameters:
messageSystemAttributes
- The message system attribute to send Each message system attribute consists of aName
,Type
, andValue
.-
Currently, the only supported message system attribute is
AWSTraceHeader
. Its type must beString
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
messageDeduplicationId
SendMessageBatchRequestEntry.Builder messageDeduplicationId(String messageDeduplicationId)
This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular
MessageDeduplicationId
is sent successfully, subsequent messages with the sameMessageDeduplicationId
are accepted successfully but aren't delivered. 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 enableContentBasedDeduplication
for your queue, Amazon SQS uses a SHA-256 hash to generate theMessageDeduplicationId
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 haveContentBasedDeduplication
set, the action fails with an error. -
If the queue has
ContentBasedDeduplication
set, yourMessageDeduplicationId
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 aMessageDeduplicationId
that is the same as the one generated for the firstMessageDeduplicationId
, 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 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.- Parameters:
messageDeduplicationId
- This parameter applies only to FIFO (first-in-first-out) queues.The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular
MessageDeduplicationId
is sent successfully, subsequent messages with the sameMessageDeduplicationId
are accepted successfully but aren't delivered. 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 enableContentBasedDeduplication
for your queue, Amazon SQS uses a SHA-256 hash to generate theMessageDeduplicationId
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 haveContentBasedDeduplication
set, the action fails with an error. -
If the queue has
ContentBasedDeduplication
set, yourMessageDeduplicationId
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 aMessageDeduplicationId
that is the same as the one generated for the firstMessageDeduplicationId
, 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 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.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
messageGroupId
SendMessageBatchRequestEntry.Builder messageGroupId(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 aMessageGroupId
, the action fails. -
ReceiveMessage
might return messages with multipleMessageGroupId
values. For eachMessageGroupId
, the messages are sorted by time sent. The caller can't specify aMessageGroupId
.
The 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.- Parameters:
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 aMessageGroupId
, the action fails. -
ReceiveMessage
might return messages with multipleMessageGroupId
values. For eachMessageGroupId
, the messages are sorted by time sent. The caller can't specify aMessageGroupId
.
The 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.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
-