public class PublishRequest extends AmazonWebServiceRequest implements java.io.Serializable
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.
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 for the TargetArn parameter. 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.
For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.
Constructor and Description |
---|
PublishRequest()
Default constructor for 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.
|
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 |
getPhoneNumber()
The phone number to which you want to deliver an SMS message.
|
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 |
setPhoneNumber(java.lang.String phoneNumber)
The phone number to which you want to deliver an SMS message.
|
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 |
withPhoneNumber(java.lang.String phoneNumber)
The phone number to which you want to deliver an SMS message.
|
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.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public PublishRequest()
public PublishRequest(java.lang.String topicArn, java.lang.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 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).
public PublishRequest(java.lang.String topicArn, java.lang.String message, java.lang.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 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.
public java.lang.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.
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 setTopicArn(java.lang.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 PublishRequest withTopicArn(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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 java.lang.String getTargetArn()
Either TopicArn or EndpointArn, but not both.
If you don't specify a value for the TargetArn
parameter,
you must specify a value for the PhoneNumber
or
TopicArn
parameters.
Either TopicArn or EndpointArn, but not both.
If you don't specify a value for the TargetArn
parameter, you must specify a value for the
PhoneNumber
or TopicArn
parameters.
public void setTargetArn(java.lang.String targetArn)
Either TopicArn or EndpointArn, but not both.
If you don't specify a value for the TargetArn
parameter,
you must specify a value for the PhoneNumber
or
TopicArn
parameters.
targetArn
- Either TopicArn or EndpointArn, but not both.
If you don't specify a value for the TargetArn
parameter, you must specify a value for the
PhoneNumber
or TopicArn
parameters.
public PublishRequest withTargetArn(java.lang.String targetArn)
Either TopicArn or EndpointArn, but not both.
If you don't specify a value for the TargetArn
parameter,
you must specify a value for the PhoneNumber
or
TopicArn
parameters.
Returns a reference to this object so that method calls can be chained together.
targetArn
- Either TopicArn or EndpointArn, but not both.
If you don't specify a value for the TargetArn
parameter, you must specify a value for the
PhoneNumber
or TopicArn
parameters.
public java.lang.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.
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 setPhoneNumber(java.lang.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 PublishRequest withPhoneNumber(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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 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).
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).
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).
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).
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.
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).
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.
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 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.
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(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.
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 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
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
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
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
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.
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
public java.util.Map<java.lang.String,MessageAttributeValue> getMessageAttributes()
Message attributes for Publish action.
Message attributes for Publish action.
public void setMessageAttributes(java.util.Map<java.lang.String,MessageAttributeValue> messageAttributes)
Message attributes for Publish action.
messageAttributes
- Message attributes for Publish action.
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.
messageAttributes
- Message attributes for Publish action.
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.
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 java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.