com.amazonaws.services.sns.model

Class PublishRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sns.model.PublishRequest

All Implemented Interfaces:

java.io.Serializable

public class PublishRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Container for the parameters to the Publish operation.

Sends a message to all of a topic's subscribed endpoints. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol selected.

To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action. The second example below shows a request and response for publishing to a mobile endpoint.

See Also:

AmazonSNS.publish(PublishRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
PublishRequest() Default constructor for a new PublishRequest object.
PublishRequest(java.lang.String topicArn, java.lang.String message) Constructs a new PublishRequest object.
PublishRequest(java.lang.String topicArn, java.lang.String message, java.lang.String subject) Constructs a new PublishRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
PublishRequest	addMessageAttributesEntry(java.lang.String key, MessageAttributeValue value) Message attributes for Publish action.
PublishRequest	clearMessageAttributesEntries() Removes all the entries added into MessageAttributes.
boolean	equals(java.lang.Object obj)
java.lang.String	getMessage() The message you want to send to the topic.
java.util.Map<java.lang.String,MessageAttributeValue>	getMessageAttributes() Message attributes for Publish action.
java.lang.String	getMessageStructure() Set MessageStructure to json if you want to send a different message for each protocol.
java.lang.String	getSubject() Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints.
java.lang.String	getTargetArn() Either TopicArn or EndpointArn, but not both.
java.lang.String	getTopicArn() The topic you want to publish to.
int	hashCode()
void	setMessage(java.lang.String message) The message you want to send to the topic.
void	setMessageAttributes(java.util.Map<java.lang.String,MessageAttributeValue> messageAttributes) Message attributes for Publish action.
void	setMessageStructure(java.lang.String messageStructure) Set MessageStructure to json if you want to send a different message for each protocol.
void	setSubject(java.lang.String subject) Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints.
void	setTargetArn(java.lang.String targetArn) Either TopicArn or EndpointArn, but not both.
void	setTopicArn(java.lang.String topicArn) The topic you want to publish to.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
PublishRequest	withMessage(java.lang.String message) The message you want to send to the topic.
PublishRequest	withMessageAttributes(java.util.Map<java.lang.String,MessageAttributeValue> messageAttributes) Message attributes for Publish action.
PublishRequest	withMessageStructure(java.lang.String messageStructure) Set MessageStructure to json if you want to send a different message for each protocol.
PublishRequest	withSubject(java.lang.String subject) Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints.
PublishRequest	withTargetArn(java.lang.String targetArn) Either TopicArn or EndpointArn, but not both.
PublishRequest	withTopicArn(java.lang.String topicArn) The topic you want to publish to.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setDelegationToken, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PublishRequest

public PublishRequest()

Default constructor for a new PublishRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

PublishRequest

public PublishRequest(java.lang.String topicArn,
              java.lang.String message)

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 to json and use a JSON object for the Message 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

public PublishRequest(java.lang.String topicArn,
              java.lang.String message,
              java.lang.String subject)

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 to json and use a JSON object for the Message 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 Detail

getTopicArn

public java.lang.String getTopicArn()

The topic you want to publish to.

Returns:

The topic you want to publish to.

setTopicArn

public void setTopicArn(java.lang.String topicArn)

The topic you want to publish to.

Parameters:

topicArn - The topic you want to publish to.

withTopicArn

public PublishRequest withTopicArn(java.lang.String topicArn)

The topic you want to publish to.

Returns a reference to this object so that method calls can be chained together.

Parameters:

topicArn - The topic you want to publish to.

Returns:

A reference to this updated object so that method calls can be chained together.

getTargetArn

public java.lang.String getTargetArn()

Either TopicArn or EndpointArn, but not both.

Returns:

Either TopicArn or EndpointArn, but not both.

setTargetArn

public void setTargetArn(java.lang.String targetArn)

Either TopicArn or EndpointArn, but not both.

Parameters:

targetArn - Either TopicArn or EndpointArn, but not both.

withTargetArn

public PublishRequest withTargetArn(java.lang.String targetArn)

Either TopicArn or EndpointArn, but not both.

Returns a reference to this object so that method calls can be chained together.

Parameters:

targetArn - Either TopicArn or EndpointArn, but not both.

Returns:

A reference to this updated object so that method calls can be chained together.

getMessage

public java.lang.String 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 to json and use a JSON object for the Message 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 to json and use a JSON object for the Message 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).

setMessage

public void setMessage(java.lang.String 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 to json and use a JSON object for the Message 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 to json and use a JSON object for the Message 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

public PublishRequest withMessage(java.lang.String 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 to json and use a JSON object for the Message 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 a reference to this object so that method calls can be chained together.

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 to json and use a JSON object for the Message 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:

A reference to this updated object so that method calls can be chained together.

getSubject

public java.lang.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.

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.

setSubject

public void setSubject(java.lang.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.

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.

withSubject

public PublishRequest withSubject(java.lang.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.

Returns a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

getMessageStructure

public java.lang.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").

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 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").

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

setMessageStructure

public void setMessageStructure(java.lang.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").

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 - 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").

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

public PublishRequest withMessageStructure(java.lang.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").

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 a reference to this object so that method calls can be chained together.

Parameters:

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").

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:

A reference to this updated object so that method calls can be chained together.

getMessageAttributes

public java.util.Map<java.lang.String,MessageAttributeValue> getMessageAttributes()

Message attributes for Publish action.

Returns:

Message attributes for Publish action.

setMessageAttributes

public void setMessageAttributes(java.util.Map<java.lang.String,MessageAttributeValue> messageAttributes)

Message attributes for Publish action.

Parameters:

messageAttributes - Message attributes for Publish action.

withMessageAttributes

public PublishRequest withMessageAttributes(java.util.Map<java.lang.String,MessageAttributeValue> messageAttributes)

Message attributes for Publish action.

Returns a reference to this object so that method calls can be chained together.

Parameters:

messageAttributes - Message attributes for Publish action.

Returns:

A reference to this updated object so that method calls can be chained together.

addMessageAttributesEntry

public PublishRequest addMessageAttributesEntry(java.lang.String key,
                                       MessageAttributeValue value)

Message attributes for Publish action.

The method adds a new key-value pair into MessageAttributes parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into MessageAttributes.

value - The corresponding value of the entry to be added into MessageAttributes.

clearMessageAttributesEntries

public PublishRequest clearMessageAttributesEntries()

Removes all the entries added into MessageAttributes.

Returns a reference to this object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object