public class PublishRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable
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.
| Constructor and Description |
|---|
PublishRequest()
Default constructor for a new 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)
Message attributes for Publish action.
|
PublishRequest |
clearMessageAttributesEntries()
Removes all the entries added into MessageAttributes.
|
PublishRequest |
clone() |
boolean |
equals(Object obj) |
String |
getMessage()
The message you want to send to the topic.
|
Map<String,MessageAttributeValue> |
getMessageAttributes()
Message attributes for Publish action.
|
String |
getMessageStructure()
Set
MessageStructure to json if you want to
send a different message for each protocol. |
String |
getSubject()
Optional parameter to be used as the "Subject" line when the message
is delivered to email endpoints.
|
String |
getTargetArn()
Either TopicArn or EndpointArn, but not both.
|
String |
getTopicArn()
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)
Set
MessageStructure to json 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.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
PublishRequest |
withMessage(String message)
The message you want to send to the topic.
|
PublishRequest |
withMessageAttributes(Map<String,MessageAttributeValue> messageAttributes)
Message attributes for Publish action.
|
PublishRequest |
withMessageStructure(String messageStructure)
Set
MessageStructure to json if you want to
send a different message for each protocol. |
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)
Either TopicArn or EndpointArn, but not both.
|
PublishRequest |
withTopicArn(String topicArn)
The topic you want to publish to.
|
copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollectorpublic PublishRequest()
public PublishRequest(String topicArn, String message)
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:
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.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:
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 String getTopicArn()
public void setTopicArn(String topicArn)
topicArn - The topic you want to publish to.public PublishRequest withTopicArn(String topicArn)
Returns a reference to this object so that method calls can be chained together.
topicArn - The topic you want to publish to.public String getTargetArn()
public void setTargetArn(String targetArn)
targetArn - Either TopicArn or EndpointArn, but not both.public PublishRequest withTargetArn(String targetArn)
Returns a reference to this object so that method calls can be chained together.
targetArn - Either TopicArn or EndpointArn, but not both.public String getMessage()
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:
Publish call to return an error (no partial
delivery).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:
Publish call to return an error (no partial
delivery).public void setMessage(String message)
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:
Publish call to return an error (no partial
delivery).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:
Publish call to return an error (no partial
delivery).public PublishRequest withMessage(String message)
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:
Publish call to return an error (no partial
delivery).Returns a reference to this object so that method calls can be chained together.
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:
Publish call to return an error (no partial
delivery).public String getSubject()
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 void setSubject(String subject)
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 PublishRequest withSubject(String subject)
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.
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 getMessageStructure()
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: 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
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: 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
public void setMessageStructure(String messageStructure)
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: 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
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: 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
public PublishRequest withMessageStructure(String messageStructure)
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: 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.
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: 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
public Map<String,MessageAttributeValue> getMessageAttributes()
public void setMessageAttributes(Map<String,MessageAttributeValue> messageAttributes)
messageAttributes - Message attributes for Publish action.public PublishRequest withMessageAttributes(Map<String,MessageAttributeValue> messageAttributes)
Returns a reference to this object so that method calls can be chained together.
messageAttributes - Message attributes for Publish action.public PublishRequest addMessageAttributesEntry(String key, MessageAttributeValue value)
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.
key - The key of the entry to be added into MessageAttributes.value - The corresponding value of the entry to be added into MessageAttributes.public PublishRequest clearMessageAttributesEntries()
Returns a reference to this object so that method calls can be chained together.
public String toString()
toString in class ObjectObject.toString()public PublishRequest clone()
clone in class com.amazonaws.AmazonWebServiceRequestCopyright © 2015. All rights reserved.