public class PublishRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Input for Publish action.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
message
The message you want to send to the topic.
|
private SdkInternalMap<java.lang.String,MessageAttributeValue> |
messageAttributes
Message attributes for Publish action.
|
private java.lang.String |
messageStructure
Set
MessageStructure to json if you want to
send a different message for each protocol. |
private java.lang.String |
subject
Optional parameter to be used as the "Subject" line when the message is
delivered to email endpoints.
|
private java.lang.String |
targetArn
Either TopicArn or EndpointArn, but not both.
|
private java.lang.String |
topicArn
The topic you want to publish to.
|
NOOP
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) |
PublishRequest |
clearMessageAttributesEntries()
Removes all the entries added into MessageAttributes.
|
PublishRequest |
clone()
Creates a shallow clone of this request.
|
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.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
private java.lang.String topicArn
The topic you want to publish to.
private java.lang.String targetArn
Either TopicArn or EndpointArn, but not both.
private 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:
Publish
call to return an error (no partial
delivery).private 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.
private 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:
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
private SdkInternalMap<java.lang.String,MessageAttributeValue> messageAttributes
Message attributes for Publish action.
public PublishRequest()
public PublishRequest(java.lang.String topicArn, java.lang.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(java.lang.String topicArn, java.lang.String message, java.lang.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 void setTopicArn(java.lang.String topicArn)
The topic you want to publish to.
topicArn
- The topic you want to publish to.public java.lang.String getTopicArn()
The topic you want to publish to.
public PublishRequest withTopicArn(java.lang.String topicArn)
The topic you want to publish to.
topicArn
- The topic you want to publish to.public void setTargetArn(java.lang.String targetArn)
Either TopicArn or EndpointArn, but not both.
targetArn
- Either TopicArn or EndpointArn, but not both.public java.lang.String getTargetArn()
Either TopicArn or EndpointArn, but not both.
public PublishRequest withTargetArn(java.lang.String targetArn)
Either TopicArn or EndpointArn, but not both.
targetArn
- Either TopicArn or EndpointArn, but not both.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:
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 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:
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 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:
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 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 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.
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.
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(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:
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 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:
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 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:
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 java.util.Map<java.lang.String,MessageAttributeValue> getMessageAttributes()
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.
messageAttributes
- Message attributes for Publish action.public PublishRequest addMessageAttributesEntry(java.lang.String key, MessageAttributeValue value)
public PublishRequest clearMessageAttributesEntries()
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public PublishRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()