@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class PublishRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Input for Publish action.
NOOP| Constructor and Description |
|---|
PublishRequest()
Default constructor for PublishRequest object.
|
PublishRequest(String topicArn,
String message)
Constructs a new PublishRequest object.
|
PublishRequest(String topicArn,
String message,
String subject)
Constructs a new PublishRequest object.
|
| Modifier and Type | Method and Description |
|---|---|
PublishRequest |
addMessageAttributesEntry(String key,
MessageAttributeValue value)
Add a single MessageAttributes entry
|
PublishRequest |
clearMessageAttributesEntries()
Removes all the entries added into MessageAttributes.
|
PublishRequest |
clone() |
boolean |
equals(Object obj) |
String |
getMessage()
The message you want to send.
|
Map<String,MessageAttributeValue> |
getMessageAttributes()
Message attributes for Publish action.
|
String |
getMessageDeduplicationId()
This parameter applies only to FIFO (first-in-first-out) topics.
|
String |
getMessageGroupId()
This parameter applies only to FIFO (first-in-first-out) topics.
|
String |
getMessageStructure()
Set
MessageStructure to json if you want to send a different message for each protocol. |
String |
getPhoneNumber()
The phone number to which you want to deliver an SMS message.
|
String |
getSubject()
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints.
|
String |
getTargetArn()
If you don't specify a value for the
TargetArn parameter, you must specify a value for the
PhoneNumber or TopicArn parameters. |
String |
getTopicArn()
The topic you want to publish to.
|
int |
hashCode() |
void |
setMessage(String message)
The message you want to send.
|
void |
setMessageAttributes(Map<String,MessageAttributeValue> messageAttributes)
Message attributes for Publish action.
|
void |
setMessageDeduplicationId(String messageDeduplicationId)
This parameter applies only to FIFO (first-in-first-out) topics.
|
void |
setMessageGroupId(String messageGroupId)
This parameter applies only to FIFO (first-in-first-out) topics.
|
void |
setMessageStructure(String messageStructure)
Set
MessageStructure to json if you want to send a different message for each protocol. |
void |
setPhoneNumber(String phoneNumber)
The phone number to which you want to deliver an SMS message.
|
void |
setSubject(String subject)
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints.
|
void |
setTargetArn(String targetArn)
If you don't specify a value for the
TargetArn parameter, you must specify a value for the
PhoneNumber or TopicArn parameters. |
void |
setTopicArn(String topicArn)
The topic you want to publish to.
|
String |
toString()
Returns a string representation of this object.
|
PublishRequest |
withMessage(String message)
The message you want to send.
|
PublishRequest |
withMessageAttributes(Map<String,MessageAttributeValue> messageAttributes)
Message attributes for Publish action.
|
PublishRequest |
withMessageDeduplicationId(String messageDeduplicationId)
This parameter applies only to FIFO (first-in-first-out) topics.
|
PublishRequest |
withMessageGroupId(String messageGroupId)
This parameter applies only to FIFO (first-in-first-out) topics.
|
PublishRequest |
withMessageStructure(String messageStructure)
Set
MessageStructure to json if you want to send a different message for each protocol. |
PublishRequest |
withPhoneNumber(String phoneNumber)
The phone number to which you want to deliver an SMS message.
|
PublishRequest |
withSubject(String subject)
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints.
|
PublishRequest |
withTargetArn(String targetArn)
If you don't specify a value for the
TargetArn parameter, you must specify a value for the
PhoneNumber or TopicArn parameters. |
PublishRequest |
withTopicArn(String topicArn)
The topic you want to publish to.
|
addHandlerContext, copyBaseTo, 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, withSdkRequestTimeoutpublic PublishRequest()
public PublishRequest(String topicArn, String message)
topicArn - The topic you want to publish to.
If you don't specify a value for the TopicArn parameter, you must specify a value for the
PhoneNumber or TargetArn parameters.
message - The message you want to send.
If you are publishing to a topic and you want to send the same message to all transport protocols, include
the text of the message as a String value. If you want to send different messages for each transport
protocol, set the value of the MessageStructure parameter to json and use a JSON
object for the Message parameter.
Constraints:
With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.
The total size limit for a single SMS Publish action is 1,600 characters.
JSON-specific constraints:
Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
The values will be parsed (unescaped) before they are used in outgoing messages.
Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
Values have a minimum length of 0 (the empty string, "", is allowed).
Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
Non-string values will cause the key to be ignored.
Keys that do not correspond to supported transport protocols are ignored.
Duplicate keys are not allowed.
Failure to parse or validate any key or value in the message will cause the Publish call to
return an error (no partial delivery).
public PublishRequest(String topicArn, String message, String subject)
topicArn - The topic you want to publish to.
If you don't specify a value for the TopicArn parameter, you must specify a value for the
PhoneNumber or TargetArn parameters.
message - The message you want to send.
If you are publishing to a topic and you want to send the same message to all transport protocols, include
the text of the message as a String value. If you want to send different messages for each transport
protocol, set the value of the MessageStructure parameter to json and use a JSON
object for the Message parameter.
Constraints:
With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.
The total size limit for a single SMS Publish action is 1,600 characters.
JSON-specific constraints:
Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
The values will be parsed (unescaped) before they are used in outgoing messages.
Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
Values have a minimum length of 0 (the empty string, "", is allowed).
Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
Non-string values will cause the key to be ignored.
Keys that do not correspond to supported transport protocols are ignored.
Duplicate keys are not allowed.
Failure to parse or validate any key or value in the message will cause the Publish call to
return an error (no partial delivery).
subject - Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This
field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
public void setTopicArn(String topicArn)
The topic you want to publish to.
If you don't specify a value for the TopicArn parameter, you must specify a value for the
PhoneNumber or TargetArn parameters.
topicArn - The topic you want to publish to.
If you don't specify a value for the TopicArn parameter, you must specify a value for the
PhoneNumber or TargetArn parameters.
public String getTopicArn()
The topic you want to publish to.
If you don't specify a value for the TopicArn parameter, you must specify a value for the
PhoneNumber or TargetArn parameters.
If you don't specify a value for the TopicArn parameter, you must specify a value for the
PhoneNumber or TargetArn parameters.
public PublishRequest withTopicArn(String topicArn)
The topic you want to publish to.
If you don't specify a value for the TopicArn parameter, you must specify a value for the
PhoneNumber or TargetArn parameters.
topicArn - The topic you want to publish to.
If you don't specify a value for the TopicArn parameter, you must specify a value for the
PhoneNumber or TargetArn parameters.
public void setTargetArn(String targetArn)
If you don't specify a value for the TargetArn parameter, you must specify a value for the
PhoneNumber or TopicArn parameters.
targetArn - If you don't specify a value for the TargetArn parameter, you must specify a value for the
PhoneNumber or TopicArn parameters.public String getTargetArn()
If you don't specify a value for the TargetArn parameter, you must specify a value for the
PhoneNumber or TopicArn parameters.
TargetArn parameter, you must specify a value for the
PhoneNumber or TopicArn parameters.public PublishRequest withTargetArn(String targetArn)
If you don't specify a value for the TargetArn parameter, you must specify a value for the
PhoneNumber or TopicArn parameters.
targetArn - If you don't specify a value for the TargetArn parameter, you must specify a value for the
PhoneNumber or TopicArn parameters.public void setPhoneNumber(String phoneNumber)
The phone number to which you want to deliver an SMS message. Use E.164 format.
If you don't specify a value for the PhoneNumber parameter, you must specify a value for the
TargetArn or TopicArn parameters.
phoneNumber - The phone number to which you want to deliver an SMS message. Use E.164 format.
If you don't specify a value for the PhoneNumber parameter, you must specify a value for the
TargetArn or TopicArn parameters.
public String getPhoneNumber()
The phone number to which you want to deliver an SMS message. Use E.164 format.
If you don't specify a value for the PhoneNumber parameter, you must specify a value for the
TargetArn or TopicArn parameters.
If you don't specify a value for the PhoneNumber parameter, you must specify a value for the
TargetArn or TopicArn parameters.
public PublishRequest withPhoneNumber(String phoneNumber)
The phone number to which you want to deliver an SMS message. Use E.164 format.
If you don't specify a value for the PhoneNumber parameter, you must specify a value for the
TargetArn or TopicArn parameters.
phoneNumber - The phone number to which you want to deliver an SMS message. Use E.164 format.
If you don't specify a value for the PhoneNumber parameter, you must specify a value for the
TargetArn or TopicArn parameters.
public void setMessage(String message)
The message you want to send.
If you are publishing to a topic and you want to send the same message to all transport protocols, include the
text of the message as a String value. If you want to send different messages for each transport protocol, set
the value of the MessageStructure parameter to json and use a JSON object for the
Message parameter.
Constraints:
With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.
The total size limit for a single SMS Publish action is 1,600 characters.
JSON-specific constraints:
Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
The values will be parsed (unescaped) before they are used in outgoing messages.
Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
Values have a minimum length of 0 (the empty string, "", is allowed).
Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
Non-string values will cause the key to be ignored.
Keys that do not correspond to supported transport protocols are ignored.
Duplicate keys are not allowed.
Failure to parse or validate any key or value in the message will cause the Publish call to return
an error (no partial delivery).
message - The message you want to send.
If you are publishing to a topic and you want to send the same message to all transport protocols, include
the text of the message as a String value. If you want to send different messages for each transport
protocol, set the value of the MessageStructure parameter to json and use a JSON
object for the Message parameter.
Constraints:
With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.
The total size limit for a single SMS Publish action is 1,600 characters.
JSON-specific constraints:
Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
The values will be parsed (unescaped) before they are used in outgoing messages.
Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
Values have a minimum length of 0 (the empty string, "", is allowed).
Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
Non-string values will cause the key to be ignored.
Keys that do not correspond to supported transport protocols are ignored.
Duplicate keys are not allowed.
Failure to parse or validate any key or value in the message will cause the Publish call to
return an error (no partial delivery).
public String getMessage()
The message you want to send.
If you are publishing to a topic and you want to send the same message to all transport protocols, include the
text of the message as a String value. If you want to send different messages for each transport protocol, set
the value of the MessageStructure parameter to json and use a JSON object for the
Message parameter.
Constraints:
With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.
The total size limit for a single SMS Publish action is 1,600 characters.
JSON-specific constraints:
Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
The values will be parsed (unescaped) before they are used in outgoing messages.
Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
Values have a minimum length of 0 (the empty string, "", is allowed).
Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
Non-string values will cause the key to be ignored.
Keys that do not correspond to supported transport protocols are ignored.
Duplicate keys are not allowed.
Failure to parse or validate any key or value in the message will cause the Publish call to return
an error (no partial delivery).
If you are publishing to a topic and you want to send the same message to all transport protocols,
include the text of the message as a String value. If you want to send different messages for each
transport protocol, set the value of the MessageStructure parameter to json and
use a JSON object for the Message parameter.
Constraints:
With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.
The total size limit for a single SMS Publish action is 1,600 characters.
JSON-specific constraints:
Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
The values will be parsed (unescaped) before they are used in outgoing messages.
Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
Values have a minimum length of 0 (the empty string, "", is allowed).
Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
Non-string values will cause the key to be ignored.
Keys that do not correspond to supported transport protocols are ignored.
Duplicate keys are not allowed.
Failure to parse or validate any key or value in the message will cause the Publish call to
return an error (no partial delivery).
public PublishRequest withMessage(String message)
The message you want to send.
If you are publishing to a topic and you want to send the same message to all transport protocols, include the
text of the message as a String value. If you want to send different messages for each transport protocol, set
the value of the MessageStructure parameter to json and use a JSON object for the
Message parameter.
Constraints:
With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.
The total size limit for a single SMS Publish action is 1,600 characters.
JSON-specific constraints:
Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
The values will be parsed (unescaped) before they are used in outgoing messages.
Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
Values have a minimum length of 0 (the empty string, "", is allowed).
Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
Non-string values will cause the key to be ignored.
Keys that do not correspond to supported transport protocols are ignored.
Duplicate keys are not allowed.
Failure to parse or validate any key or value in the message will cause the Publish call to return
an error (no partial delivery).
message - The message you want to send.
If you are publishing to a topic and you want to send the same message to all transport protocols, include
the text of the message as a String value. If you want to send different messages for each transport
protocol, set the value of the MessageStructure parameter to json and use a JSON
object for the Message parameter.
Constraints:
With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.
The total size limit for a single SMS Publish action is 1,600 characters.
JSON-specific constraints:
Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
The values will be parsed (unescaped) before they are used in outgoing messages.
Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
Values have a minimum length of 0 (the empty string, "", is allowed).
Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
Non-string values will cause the key to be ignored.
Keys that do not correspond to supported transport protocols are ignored.
Duplicate keys are not allowed.
Failure to parse or validate any key or value in the message will cause the Publish call to
return an error (no partial delivery).
public void setSubject(String subject)
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
subject - Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This
field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
public String getSubject()
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
public PublishRequest withSubject(String subject)
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
subject - Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This
field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
public void setMessageStructure(String messageStructure)
Set MessageStructure to json 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 set MessageStructure to json, the value of the
Message 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").
Valid value: json
messageStructure - Set MessageStructure to json 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 set MessageStructure to json,
the value of the Message 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").
Valid value: json
public String getMessageStructure()
Set MessageStructure to json 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 set MessageStructure to json, the value of the
Message 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").
Valid value: json
MessageStructure to json 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 set MessageStructure to json
, the value of the Message 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").
Valid value: json
public PublishRequest withMessageStructure(String messageStructure)
Set MessageStructure to json 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 set MessageStructure to json, the value of the
Message 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").
Valid value: json
messageStructure - Set MessageStructure to json 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 set MessageStructure to json,
the value of the Message 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").
Valid value: json
public Map<String,MessageAttributeValue> getMessageAttributes()
Message attributes for Publish action.
public void setMessageAttributes(Map<String,MessageAttributeValue> messageAttributes)
Message attributes for Publish action.
messageAttributes - Message attributes for Publish action.public PublishRequest withMessageAttributes(Map<String,MessageAttributeValue> messageAttributes)
Message attributes for Publish action.
messageAttributes - Message attributes for Publish action.public PublishRequest addMessageAttributesEntry(String key, MessageAttributeValue value)
public PublishRequest clearMessageAttributesEntries()
public void setMessageDeduplicationId(String messageDeduplicationId)
This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId can
contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
Every message must have a unique MessageDeduplicationId, which is a token used for deduplication of
sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any
message sent with the same MessageDeduplicationId during the 5-minute deduplication interval is
treated as a duplicate.
If the topic has ContentBasedDeduplication set, the system generates a
MessageDeduplicationId based on the contents of the message. Your
MessageDeduplicationId overrides the generated one.
messageDeduplicationId - This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId
can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
Every message must have a unique MessageDeduplicationId, which is a token used for
deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent
successfully, any message sent with the same MessageDeduplicationId during the 5-minute
deduplication interval is treated as a duplicate.
If the topic has ContentBasedDeduplication set, the system generates a
MessageDeduplicationId based on the contents of the message. Your
MessageDeduplicationId overrides the generated one.
public String getMessageDeduplicationId()
This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId can
contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
Every message must have a unique MessageDeduplicationId, which is a token used for deduplication of
sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any
message sent with the same MessageDeduplicationId during the 5-minute deduplication interval is
treated as a duplicate.
If the topic has ContentBasedDeduplication set, the system generates a
MessageDeduplicationId based on the contents of the message. Your
MessageDeduplicationId overrides the generated one.
MessageDeduplicationId
can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
Every message must have a unique MessageDeduplicationId, which is a token used for
deduplication of sent messages. If a message with a particular MessageDeduplicationId is
sent successfully, any message sent with the same MessageDeduplicationId during the 5-minute
deduplication interval is treated as a duplicate.
If the topic has ContentBasedDeduplication set, the system generates a
MessageDeduplicationId based on the contents of the message. Your
MessageDeduplicationId overrides the generated one.
public PublishRequest withMessageDeduplicationId(String messageDeduplicationId)
This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId can
contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
Every message must have a unique MessageDeduplicationId, which is a token used for deduplication of
sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any
message sent with the same MessageDeduplicationId during the 5-minute deduplication interval is
treated as a duplicate.
If the topic has ContentBasedDeduplication set, the system generates a
MessageDeduplicationId based on the contents of the message. Your
MessageDeduplicationId overrides the generated one.
messageDeduplicationId - This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId
can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
Every message must have a unique MessageDeduplicationId, which is a token used for
deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent
successfully, any message sent with the same MessageDeduplicationId during the 5-minute
deduplication interval is treated as a duplicate.
If the topic has ContentBasedDeduplication set, the system generates a
MessageDeduplicationId based on the contents of the message. Your
MessageDeduplicationId overrides the generated one.
public void setMessageGroupId(String messageGroupId)
This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can contain up
to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
The MessageGroupId is a 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). Every message must include a MessageGroupId.
messageGroupId - This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can
contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
The MessageGroupId is a 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). Every message must include a
MessageGroupId.
public String getMessageGroupId()
This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can contain up
to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
The MessageGroupId is a 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). Every message must include a MessageGroupId.
MessageGroupId can
contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
The MessageGroupId is a 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). Every message must include a
MessageGroupId.
public PublishRequest withMessageGroupId(String messageGroupId)
This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can contain up
to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
The MessageGroupId is a 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). Every message must include a MessageGroupId.
messageGroupId - This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can
contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
The MessageGroupId is a 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). Every message must include a
MessageGroupId.
public String toString()
toString in class ObjectObject.toString()public PublishRequest clone()
clone in class AmazonWebServiceRequestCopyright © 2024. All rights reserved.