Class PublishBatchRequestEntry
- java.lang.Object
-
- software.amazon.awssdk.services.sns.model.PublishBatchRequestEntry
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<PublishBatchRequestEntry.Builder,PublishBatchRequestEntry>
@Generated("software.amazon.awssdk:codegen") public final class PublishBatchRequestEntry extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PublishBatchRequestEntry.Builder,PublishBatchRequestEntry>
Contains the details of a single Amazon SNS message along with an
Id
that identifies a message within the batch.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
PublishBatchRequestEntry.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PublishBatchRequestEntry.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasMessageAttributes()
For responses, this returns true if the service returned a value for the MessageAttributes property.String
id()
An identifier for the message in this batch.String
message()
The body of the message.Map<String,MessageAttributeValue>
messageAttributes()
Each message attribute consists of aName
,Type
, andValue
.String
messageDeduplicationId()
This parameter applies only to FIFO (first-in-first-out) topics.String
messageGroupId()
This parameter applies only to FIFO (first-in-first-out) topics.String
messageStructure()
SetMessageStructure
tojson
if you want to send a different message for each protocol.List<SdkField<?>>
sdkFields()
static Class<? extends PublishBatchRequestEntry.Builder>
serializableBuilderClass()
String
subject()
The subject of the batch message.PublishBatchRequestEntry.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
id
public final 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 (_).
- Returns:
- 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 (_).
-
message
public final String message()
The body of the message.
- Returns:
- The body of the message.
-
subject
public final String subject()
The subject of the batch message.
- Returns:
- The subject of the batch message.
-
messageStructure
public final 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).
- Returns:
- 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).
-
-
-
hasMessageAttributes
public final boolean hasMessageAttributes()
For responses, this returns true if the service returned a value for the MessageAttributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
messageAttributes
public final 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.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasMessageAttributes()
method.- Returns:
- Each message attribute consists of a
Name
,Type
, andValue
. For more information, see Amazon SNS message attributes in the Amazon SNS Developer Guide.
-
messageDeduplicationId
public final 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(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.- Returns:
- 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(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
. -
-
-
messageGroupId
public final 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.- Returns:
- 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.
-
toBuilder
public PublishBatchRequestEntry.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<PublishBatchRequestEntry.Builder,PublishBatchRequestEntry>
-
builder
public static PublishBatchRequestEntry.Builder builder()
-
serializableBuilderClass
public static Class<? extends PublishBatchRequestEntry.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
-