Class PublishRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Input for Publish action.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
ConstructorsConstructorDescriptionDefault 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. -
Method Summary
Modifier and TypeMethodDescriptionaddMessageAttributesEntry
(String key, MessageAttributeValue value) Removes all the entries added into MessageAttributes.clone()
Creates a shallow clone of this request.boolean
The message you want to send to the topic.Message attributes for Publish action.SetMessageStructure
tojson
if you want to send a different message for each protocol.Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints.Either TopicArn or EndpointArn, but not both.The topic you want to publish to.int
hashCode()
void
setMessage
(String message) The message you want to send to the topic.void
setMessageAttributes
(Map<String, MessageAttributeValue> messageAttributes) Message attributes for Publish action.void
setMessageStructure
(String messageStructure) SetMessageStructure
tojson
if you want to send a different message for each protocol.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) Either TopicArn or EndpointArn, but not both.void
setTopicArn
(String topicArn) The topic you want to publish to.toString()
Returns a string representation of this object; useful for testing and debugging.withMessage
(String message) The message you want to send to the topic.withMessageAttributes
(Map<String, MessageAttributeValue> messageAttributes) Message attributes for Publish action.withMessageStructure
(String messageStructure) SetMessageStructure
tojson
if you want to send a different message for each protocol.withSubject
(String subject) Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints.withTargetArn
(String targetArn) Either TopicArn or EndpointArn, but not both.withTopicArn
(String topicArn) The topic you want to publish to.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
PublishRequest
public PublishRequest()Default constructor for PublishRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it. -
PublishRequest
Constructs a new PublishRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
topicArn
- The topic you want to publish to.message
- The message you want to send to the topic.If 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 tojson
and use a JSON object for theMessage
parameter. See the Examples section for the format of the JSON object.Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 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).
-
PublishRequest
Constructs a new PublishRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
topicArn
- The topic you want to publish to.message
- The message you want to send to the topic.If 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 tojson
and use a JSON object for theMessage
parameter. See the Examples section for the format of the JSON object.Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 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.
-
-
Method Details
-
setTopicArn
The topic you want to publish to.
- Parameters:
topicArn
- The topic you want to publish to.
-
getTopicArn
The topic you want to publish to.
- Returns:
- The topic you want to publish to.
-
withTopicArn
The topic you want to publish to.
- Parameters:
topicArn
- The topic you want to publish to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTargetArn
Either TopicArn or EndpointArn, but not both.
- Parameters:
targetArn
- Either TopicArn or EndpointArn, but not both.
-
getTargetArn
Either TopicArn or EndpointArn, but not both.
- Returns:
- Either TopicArn or EndpointArn, but not both.
-
withTargetArn
Either TopicArn or EndpointArn, but not both.
- Parameters:
targetArn
- Either TopicArn or EndpointArn, but not both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMessage
The message you want to send to the topic.
If 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 tojson
and use a JSON object for theMessage
parameter. See the Examples section for the format of the JSON object.Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 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).
- Parameters:
message
- The message you want to send to the topic.If 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 tojson
and use a JSON object for theMessage
parameter. See the Examples section for the format of the JSON object.Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 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).
-
getMessage
The message you want to send to the topic.
If 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 tojson
and use a JSON object for theMessage
parameter. See the Examples section for the format of the JSON object.Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 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).
- Returns:
- The message you want to send to the topic.
If 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 tojson
and use a JSON object for theMessage
parameter. See the Examples section for the format of the JSON object.Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 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).
-
withMessage
The message you want to send to the topic.
If 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 tojson
and use a JSON object for theMessage
parameter. See the Examples section for the format of the JSON object.Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 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).
- Parameters:
message
- The message you want to send to the topic.If 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 tojson
and use a JSON object for theMessage
parameter. See the Examples section for the format of the JSON object.Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 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).
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSubject
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.
- Parameters:
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.
-
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.
- Returns:
- 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.
-
withSubject
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMessageStructure
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").
For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide.
Valid value:
json
- 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").
For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide.
Valid value:
json
-
getMessageStructure
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").
For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide.
Valid value:
json
- 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").
For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide.
Valid value:
json
-
withMessageStructure
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").
For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide.
Valid value:
json
- 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").
For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide.
Valid value:
json
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getMessageAttributes
Message attributes for Publish action.
- Returns:
- Message attributes for Publish action.
-
setMessageAttributes
Message attributes for Publish action.
- Parameters:
messageAttributes
- Message attributes for Publish action.
-
withMessageAttributes
Message attributes for Publish action.
- Parameters:
messageAttributes
- Message attributes for Publish action.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addMessageAttributesEntry
-
clearMessageAttributesEntries
Removes all the entries added into MessageAttributes. <p> Returns a reference to this object so that method calls can be chained together. -
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-