@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class PublishRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Input for Publish action.
NOOP| Constructor and Description |
|---|
PublishRequest()
Default constructor for PublishRequest object.
|
PublishRequest(String topicArn,
String message)
Constructs a new PublishRequest object.
|
PublishRequest(String topicArn,
String message,
String subject)
Constructs a new PublishRequest object.
|
| Modifier and Type | Method and Description |
|---|---|
PublishRequest |
addMessageAttributesEntry(String key,
MessageAttributeValue value) |
PublishRequest |
clearMessageAttributesEntries()
Removes all the entries added into MessageAttributes.
|
PublishRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
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 |
getPhoneNumber()
The phone number to which you want to deliver an SMS message.
|
String |
getSubject()
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints.
|
String |
getTargetArn()
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 |
setPhoneNumber(String phoneNumber)
The phone number to which you want to deliver an SMS message.
|
void |
setSubject(String subject)
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints.
|
void |
setTargetArn(String targetArn)
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 |
withPhoneNumber(String phoneNumber)
The phone number to which you want to deliver an SMS message.
|
PublishRequest |
withSubject(String subject)
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints.
|
PublishRequest |
withTargetArn(String targetArn)
Either TopicArn or EndpointArn, but not both.
|
PublishRequest |
withTopicArn(String topicArn)
The topic you want to publish to.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic PublishRequest()
public PublishRequest(String topicArn, String message)
topicArn - The topic you want to publish to.
If you don't specify a value for the TopicArn parameter, you must specify a value for the
PhoneNumber or TargetArn parameters.
message - The message you want to send 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.
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(String topicArn, String message, String subject)
topicArn - The topic you want to publish to.
If you don't specify a value for the TopicArn parameter, you must specify a value for the
PhoneNumber or TargetArn parameters.
message - The message you want to send 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.
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 void setTopicArn(String topicArn)
The topic you want to publish to.
If you don't specify a value for the TopicArn parameter, you must specify a value for the
PhoneNumber or TargetArn parameters.
topicArn - The topic you want to publish to.
If you don't specify a value for the TopicArn parameter, you must specify a value for the
PhoneNumber or TargetArn parameters.
public String getTopicArn()
The topic you want to publish to.
If you don't specify a value for the TopicArn parameter, you must specify a value for the
PhoneNumber or TargetArn parameters.
If you don't specify a value for the TopicArn parameter, you must specify a value for the
PhoneNumber or TargetArn parameters.
public PublishRequest withTopicArn(String topicArn)
The topic you want to publish to.
If you don't specify a value for the TopicArn parameter, you must specify a value for the
PhoneNumber or TargetArn parameters.
topicArn - The topic you want to publish to.
If you don't specify a value for the TopicArn parameter, you must specify a value for the
PhoneNumber or TargetArn parameters.
public void setTargetArn(String targetArn)
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 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.
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(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 void setPhoneNumber(String phoneNumber)
The phone number to which you want to deliver an SMS message. Use E.164 format.
If you don't specify a value for the PhoneNumber parameter, you must specify a value for the
TargetArn or TopicArn parameters.
phoneNumber - The phone number to which you want to deliver an SMS message. Use E.164 format.
If you don't specify a value for the PhoneNumber parameter, you must specify a value for the
TargetArn or TopicArn parameters.
public String getPhoneNumber()
The phone number to which you want to deliver an SMS message. Use E.164 format.
If you don't specify a value for the PhoneNumber parameter, you must specify a value for the
TargetArn or TopicArn parameters.
If you don't specify a value for the PhoneNumber parameter, you must specify a value for the
TargetArn or TopicArn parameters.
public PublishRequest withPhoneNumber(String phoneNumber)
The phone number to which you want to deliver an SMS message. Use E.164 format.
If you don't specify a value for the PhoneNumber parameter, you must specify a value for the
TargetArn or TopicArn parameters.
phoneNumber - The phone number to which you want to deliver an SMS message. Use E.164 format.
If you don't specify a value for the PhoneNumber parameter, you must specify a value for the
TargetArn or TopicArn parameters.
public void setMessage(String message)
The message you want to send 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.
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.
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 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.
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).
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.
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(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.
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.
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 setSubject(String subject)
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
subject - Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This
field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
public String getSubject()
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
public PublishRequest withSubject(String subject)
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
subject - Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This
field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
public void setMessageStructure(String messageStructure)
Set MessageStructure to json if you want to send a different message for each protocol.
For example, using one publish action, you can send a short message to your SMS subscribers and a longer message
to your email subscribers. If you set MessageStructure to json, the value of the
Message parameter must:
be a syntactically valid JSON object; and
contain at least a top-level JSON key of "default" with a value that is a string.
You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").
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 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
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(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 Map<String,MessageAttributeValue> getMessageAttributes()
Message attributes for Publish action.
public void setMessageAttributes(Map<String,MessageAttributeValue> messageAttributes)
Message attributes for Publish action.
messageAttributes - Message attributes for Publish action.public PublishRequest withMessageAttributes(Map<String,MessageAttributeValue> messageAttributes)
Message attributes for Publish action.
messageAttributes - Message attributes for Publish action.public PublishRequest addMessageAttributesEntry(String key, MessageAttributeValue value)
public PublishRequest clearMessageAttributesEntries()
public String toString()
toString in class ObjectObject.toString()public PublishRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.