Interface PublishBatchRequestEntry.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<PublishBatchRequestEntry.Builder,PublishBatchRequestEntry>
,SdkBuilder<PublishBatchRequestEntry.Builder,PublishBatchRequestEntry>
,SdkPojo
- Enclosing class:
- PublishBatchRequestEntry
public static interface PublishBatchRequestEntry.Builder extends SdkPojo, CopyableBuilder<PublishBatchRequestEntry.Builder,PublishBatchRequestEntry>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description PublishBatchRequestEntry.Builder
id(String id)
An identifier for the message in this batch.PublishBatchRequestEntry.Builder
message(String message)
The body of the message.PublishBatchRequestEntry.Builder
messageAttributes(Map<String,MessageAttributeValue> messageAttributes)
Each message attribute consists of aName
,Type
, andValue
.PublishBatchRequestEntry.Builder
messageDeduplicationId(String messageDeduplicationId)
This parameter applies only to FIFO (first-in-first-out) topics.PublishBatchRequestEntry.Builder
messageGroupId(String messageGroupId)
This parameter applies only to FIFO (first-in-first-out) topics.PublishBatchRequestEntry.Builder
messageStructure(String messageStructure)
SetMessageStructure
tojson
if you want to send a different message for each protocol.PublishBatchRequestEntry.Builder
subject(String subject)
The subject of the batch message.-
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
PublishBatchRequestEntry.Builder id(String id)
An identifier for the message in this batch.
The
Ids
of a batch request must 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 the message in this batch.The
Ids
of a batch request must 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.
-
message
PublishBatchRequestEntry.Builder message(String message)
The body of the message.
- Parameters:
message
- The body of the message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subject
PublishBatchRequestEntry.Builder subject(String subject)
The subject of the batch message.
- Parameters:
subject
- The subject of the batch message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
messageStructure
PublishBatchRequestEntry.Builder messageStructure(String messageStructure)
Set
MessageStructure
tojson
if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you setMessageStructure
tojson
, the value of theMessage
parameter must:-
be a syntactically valid JSON object; and
-
contain at least a top-level JSON key of "default" with a value that is a string.
You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g. http).
- Parameters:
messageStructure
- SetMessageStructure
tojson
if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you setMessageStructure
tojson
, the value of theMessage
parameter must:-
be a syntactically valid JSON object; and
-
contain at least a top-level JSON key of "default" with a value that is a string.
You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g. http).
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
messageAttributes
PublishBatchRequestEntry.Builder messageAttributes(Map<String,MessageAttributeValue> messageAttributes)
Each message attribute consists of a
Name
,Type
, andValue
. For more information, see Amazon SNS message attributes in the Amazon SNS Developer Guide.- Parameters:
messageAttributes
- Each message attribute consists of aName
,Type
, andValue
. For more information, see Amazon SNS message attributes in the Amazon SNS Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
messageDeduplicationId
PublishBatchRequestEntry.Builder messageDeduplicationId(String messageDeduplicationId)
This parameter applies only to FIFO (first-in-first-out) topics.
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.-
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 topic, Amazon SNS 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 topic doesn't haveContentBasedDeduplication
set, the action fails with an error. -
If the topic has a
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 SNS can't detect duplicate messages.Amazon SNS 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(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.- Parameters:
messageDeduplicationId
- This parameter applies only to FIFO (first-in-first-out) topics.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.-
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 topic, Amazon SNS 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 topic doesn't haveContentBasedDeduplication
set, the action fails with an error. -
If the topic has a
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 SNS can't detect duplicate messages.Amazon SNS 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(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
messageGroupId
PublishBatchRequestEntry.Builder messageGroupId(String messageGroupId)
This parameter applies only to FIFO (first-in-first-out) topics.
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 topic, use
MessageGroupId
values (for example, session data for multiple users). In this scenario, multiple consumers can process the topic, 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.The length of
MessageGroupId
is 128 characters.MessageGroupId
can contain alphanumeric characters(a-z, A-Z, 0-9)
and punctuation(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.MessageGroupId
is required for FIFO topics. You can't use it for standard topics.- Parameters:
messageGroupId
- This parameter applies only to FIFO (first-in-first-out) topics.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 topic, use
MessageGroupId
values (for example, session data for multiple users). In this scenario, multiple consumers can process the topic, 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.The length of
MessageGroupId
is 128 characters.MessageGroupId
can contain alphanumeric characters(a-z, A-Z, 0-9)
and punctuation(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.MessageGroupId
is required for FIFO topics. You can't use it for standard topics.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-