PublishRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.sns.model.PublishRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class PublishRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the TargetArn).

If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.

When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it shortly.

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.

For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.

You can publish messages only to topics and endpoints in the same AWS Region.

See Also:

Serialized Form

Constructor Summary

Constructors
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.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PublishRequest`	`addMessageAttributesEntry(java.lang.String key, MessageAttributeValue value)` Message attributes for Publish action.
`PublishRequest`	`clearMessageAttributesEntries()` Removes all the entries added into MessageAttributes.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getMessage()` The message you want to send.
`java.util.Map<java.lang.String,MessageAttributeValue>`	`getMessageAttributes()` Message attributes for Publish action.
`java.lang.String`	`getMessageDeduplicationId()` This parameter applies only to FIFO (first-in-first-out) topics.
`java.lang.String`	`getMessageGroupId()` This parameter applies only to FIFO (first-in-first-out) topics.
`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()` If you don't specify a value for the `TargetArn` parameter, you must specify a value for the `PhoneNumber` or `TopicArn` parameters.
`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.
`void`	`setMessageAttributes(java.util.Map<java.lang.String,MessageAttributeValue> messageAttributes)` Message attributes for Publish action.
`void`	`setMessageDeduplicationId(java.lang.String messageDeduplicationId)` This parameter applies only to FIFO (first-in-first-out) topics.
`void`	`setMessageGroupId(java.lang.String messageGroupId)` This parameter applies only to FIFO (first-in-first-out) topics.
`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)` If you don't specify a value for the `TargetArn` parameter, you must specify a value for the `PhoneNumber` or `TopicArn` parameters.
`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.
`PublishRequest`	`withMessageAttributes(java.util.Map<java.lang.String,MessageAttributeValue> messageAttributes)` Message attributes for Publish action.
`PublishRequest`	`withMessageDeduplicationId(java.lang.String messageDeduplicationId)` This parameter applies only to FIFO (first-in-first-out) topics.
`PublishRequest`	`withMessageGroupId(java.lang.String messageGroupId)` This parameter applies only to FIFO (first-in-first-out) topics.
`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)` If you don't specify a value for the `TargetArn` parameter, you must specify a value for the `PhoneNumber` or `TopicArn` parameters.
`PublishRequest`	`withTopicArn(java.lang.String topicArn)` The topic you want to publish to.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PublishRequest
```
public PublishRequest()
```
    Default constructor for PublishRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
  - PublishRequest
```
public PublishRequest(java.lang.String topicArn,
                      java.lang.String message)
```
    Constructs a new PublishRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
    Parameters:
    
    topicArn -
    The topic you want to publish to.
    
    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.
    
    If you are publishing to a topic and 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:
    
    With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
    
    For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
    
    If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.
    
    The total size limit for a single SMS Publish action is 1,600 characters.
    
    JSON-specific constraints:
    
    Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
    
    The values will be parsed (unescaped) before they are used in outgoing messages.
    
    Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
    
    Values have a minimum length of 0 (the empty string, "", is allowed).
    
    Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
    
    Non-string values will cause the key to be ignored.
    
    Keys that do not correspond to supported transport protocols are ignored.
    
    Duplicate keys are not allowed.
    
    Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
  - PublishRequest
```
public PublishRequest(java.lang.String topicArn,
                      java.lang.String message,
                      java.lang.String subject)
```
    Constructs a new PublishRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
    Parameters:
    
    topicArn -
    The topic you want to publish to.
    
    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.
    
    If you are publishing to a topic and 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:
    
    With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
    
    For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
    
    If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.
    
    The total size limit for a single SMS Publish action is 1,600 characters.
    
    JSON-specific constraints:
    
    Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
    
    The values will be parsed (unescaped) before they are used in outgoing messages.
    
    Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
    
    Values have a minimum length of 0 (the empty string, "", is allowed).
    
    Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
    
    Non-string values will cause the key to be ignored.
    
    Keys that do not correspond to supported transport protocols are ignored.
    
    Duplicate keys are not allowed.
    
    Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
    subject -
    Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
    
    Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
- Method Detail
  - getTopicArn
```
public java.lang.String getTopicArn()
```
    The topic you want to publish to.
    
    If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters.
    
    Returns:
    
    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.
  - setTopicArn
```
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.
    
    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.
  - withTopicArn
```
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.
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getTargetArn
```
public java.lang.String getTargetArn()
```
    If you don't specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters.
    
    Returns:
    
    If you don't specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters.
  - setTargetArn
```
public void setTargetArn(java.lang.String targetArn)
```
    If you don't specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters.
    
    Parameters:
    
    targetArn -
    If you don't specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters.
  - withTargetArn
```
public PublishRequest withTargetArn(java.lang.String targetArn)
```
    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.
    
    Parameters:
    
    targetArn -
    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 updated object so that method calls can be chained together.
  - getPhoneNumber
```
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.
    
    Returns:
    
    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.
  - setPhoneNumber
```
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.
    
    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.
  - withPhoneNumber
```
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.
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMessage
```
public java.lang.String getMessage()
```
    The message you want to send.
    
    If you are publishing to a topic and 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:
    - With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
    - For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
      
      If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.
      
      The total size limit for a single SMS Publish action is 1,600 characters.
    JSON-specific constraints:
    - Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
    - The values will be parsed (unescaped) before they are used in outgoing messages.
    - Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
    - Values have a minimum length of 0 (the empty string, "", is allowed).
    - Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
    - Non-string values will cause the key to be ignored.
    - Keys that do not correspond to supported transport protocols are ignored.
    - Duplicate keys are not allowed.
    - Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
    Returns:
    The message you want to send.
    
    If you are publishing to a topic and 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:
    
    With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
    
    For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
    
    If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.
    
    The total size limit for a single SMS Publish action is 1,600 characters.
    
    JSON-specific constraints:
    
    Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
    
    The values will be parsed (unescaped) before they are used in outgoing messages.
    
    Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
    
    Values have a minimum length of 0 (the empty string, "", is allowed).
    
    Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
    
    Non-string values will cause the key to be ignored.
    
    Keys that do not correspond to supported transport protocols are ignored.
    
    Duplicate keys are not allowed.
    
    Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
  - setMessage
```
public void setMessage(java.lang.String message)
```
    The message you want to send.
    
    If you are publishing to a topic and 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:
    - With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
    - For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
      
      If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.
      
      The total size limit for a single SMS Publish action is 1,600 characters.
    JSON-specific constraints:
    - Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
    - The values will be parsed (unescaped) before they are used in outgoing messages.
    - Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
    - Values have a minimum length of 0 (the empty string, "", is allowed).
    - Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
    - Non-string values will cause the key to be ignored.
    - Keys that do not correspond to supported transport protocols are ignored.
    - Duplicate keys are not allowed.
    - Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
    Parameters:
    message -
    The message you want to send.
    
    If you are publishing to a topic and 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:
    
    With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
    
    For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
    
    If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.
    
    The total size limit for a single SMS Publish action is 1,600 characters.
    
    JSON-specific constraints:
    
    Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
    
    The values will be parsed (unescaped) before they are used in outgoing messages.
    
    Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
    
    Values have a minimum length of 0 (the empty string, "", is allowed).
    
    Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
    
    Non-string values will cause the key to be ignored.
    
    Keys that do not correspond to supported transport protocols are ignored.
    
    Duplicate keys are not allowed.
    
    Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
  - withMessage
```
public PublishRequest withMessage(java.lang.String message)
```
    The message you want to send.
    
    If you are publishing to a topic and 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:
    - With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
    - For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
      
      If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.
      
      The total size limit for a single SMS Publish action is 1,600 characters.
    JSON-specific constraints:
    - Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
    - The values will be parsed (unescaped) before they are used in outgoing messages.
    - Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
    - Values have a minimum length of 0 (the empty string, "", is allowed).
    - Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
    - Non-string values will cause the key to be ignored.
    - Keys that do not correspond to supported transport protocols are ignored.
    - Duplicate keys are not allowed.
    - Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    message -
    The message you want to send.
    
    If you are publishing to a topic and 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:
    
    With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
    
    For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
    
    If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.
    
    The total size limit for a single SMS Publish action is 1,600 characters.
    
    JSON-specific constraints:
    
    Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
    
    The values will be parsed (unescaped) before they are used in outgoing messages.
    
    Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
    
    Values have a minimum length of 0 (the empty string, "", is allowed).
    
    Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
    
    Non-string values will cause the key to be ignored.
    
    Keys that do not correspond to supported transport protocols are ignored.
    
    Duplicate keys are not allowed.
    
    Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSubject
```
public java.lang.String getSubject()
```
    Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
    
    Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
    
    Returns:
    
    Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
    
    Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
  - setSubject
```
public void setSubject(java.lang.String subject)
```
    Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
    
    Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
    
    Parameters:
    
    subject -
    Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
    
    Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
  - withSubject
```
public PublishRequest withSubject(java.lang.String subject)
```
    Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
    
    Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    subject -
    Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
    
    Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMessageStructure
```
public java.lang.String getMessageStructure()
```
    Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:
    - be a syntactically valid JSON object; and
    - contain at least a top-level JSON key of "default" with a value that is a string.
    You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").
    
    Valid value: json
    Returns:
    Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:
    
    be a syntactically valid JSON object; and
    
    contain at least a top-level JSON key of "default" with a value that is a string.
    
    You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").
    
    Valid value: json
  - setMessageStructure
```
public void setMessageStructure(java.lang.String messageStructure)
```
    Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:
    - be a syntactically valid JSON object; and
    - contain at least a top-level JSON key of "default" with a value that is a string.
    You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").
    
    Valid value: json
    Parameters:
    messageStructure -
    Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:
    
    be a syntactically valid JSON object; and
    
    contain at least a top-level JSON key of "default" with a value that is a string.
    
    You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").
    
    Valid value: json
  - withMessageStructure
```
public PublishRequest withMessageStructure(java.lang.String messageStructure)
```
    Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:
    - be a syntactically valid JSON object; and
    - contain at least a top-level JSON key of "default" with a value that is a string.
    You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").
    
    Valid value: json
    
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    messageStructure -
    Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:
    
    be a syntactically valid JSON object; and
    
    contain at least a top-level JSON key of "default" with a value that is a string.
    
    You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").
    
    Valid value: json
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMessageAttributes
```
public java.util.Map<java.lang.String,MessageAttributeValue> getMessageAttributes()
```
    Message attributes for Publish action.
    
    Returns:
    
    Message attributes for Publish action.
  - setMessageAttributes
```
public void setMessageAttributes(java.util.Map<java.lang.String,MessageAttributeValue> messageAttributes)
```
    Message attributes for Publish action.
    
    Parameters:
    
    messageAttributes -
    Message attributes for Publish action.
  - withMessageAttributes
```
public PublishRequest withMessageAttributes(java.util.Map<java.lang.String,MessageAttributeValue> messageAttributes)
```
    Message attributes for Publish action.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    messageAttributes -
    Message attributes for Publish action.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addMessageAttributesEntry
```
public PublishRequest addMessageAttributesEntry(java.lang.String key,
                                                MessageAttributeValue value)
```
    Message attributes for Publish action.
    
    The method adds a new key-value pair into MessageAttributes parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into MessageAttributes.
    
    value - The corresponding value of the entry to be added into MessageAttributes.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearMessageAttributesEntries
```
public PublishRequest clearMessageAttributesEntries()
```
    Removes all the entries added into MessageAttributes.
    Returns a reference to this object so that method calls can be chained together.
  - getMessageDeduplicationId
```
public java.lang.String getMessageDeduplicationId()
```
    This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    Every message must have a unique MessageDeduplicationId, which is a token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any message sent with the same MessageDeduplicationId during the 5-minute deduplication interval is treated as a duplicate.
    
    If the topic has ContentBasedDeduplication set, the system generates a MessageDeduplicationId based on the contents of the message. Your MessageDeduplicationId overrides the generated one.
    
    Returns:
    
    This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    Every message must have a unique MessageDeduplicationId, which is a token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any message sent with the same MessageDeduplicationId during the 5-minute deduplication interval is treated as a duplicate.
    
    If the topic has ContentBasedDeduplication set, the system generates a MessageDeduplicationId based on the contents of the message. Your MessageDeduplicationId overrides the generated one.
  - setMessageDeduplicationId
```
public void setMessageDeduplicationId(java.lang.String messageDeduplicationId)
```
    This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    Every message must have a unique MessageDeduplicationId, which is a token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any message sent with the same MessageDeduplicationId during the 5-minute deduplication interval is treated as a duplicate.
    
    If the topic has ContentBasedDeduplication set, the system generates a MessageDeduplicationId based on the contents of the message. Your MessageDeduplicationId overrides the generated one.
    
    Parameters:
    
    messageDeduplicationId -
    This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    Every message must have a unique MessageDeduplicationId, which is a token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any message sent with the same MessageDeduplicationId during the 5-minute deduplication interval is treated as a duplicate.
    
    If the topic has ContentBasedDeduplication set, the system generates a MessageDeduplicationId based on the contents of the message. Your MessageDeduplicationId overrides the generated one.
  - withMessageDeduplicationId
```
public PublishRequest withMessageDeduplicationId(java.lang.String messageDeduplicationId)
```
    This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    Every message must have a unique MessageDeduplicationId, which is a token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any message sent with the same MessageDeduplicationId during the 5-minute deduplication interval is treated as a duplicate.
    
    If the topic has ContentBasedDeduplication set, the system generates a MessageDeduplicationId based on the contents of the message. Your MessageDeduplicationId overrides the generated one.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    messageDeduplicationId -
    This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    Every message must have a unique MessageDeduplicationId, which is a token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any message sent with the same MessageDeduplicationId during the 5-minute deduplication interval is treated as a duplicate.
    
    If the topic has ContentBasedDeduplication set, the system generates a MessageDeduplicationId based on the contents of the message. Your MessageDeduplicationId overrides the generated one.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMessageGroupId
```
public java.lang.String getMessageGroupId()
```
    This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    The MessageGroupId is a tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). Every message must include a MessageGroupId.
    
    Returns:
    
    This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    The MessageGroupId is a tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). Every message must include a MessageGroupId.
  - setMessageGroupId
```
public void setMessageGroupId(java.lang.String messageGroupId)
```
    This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    The MessageGroupId is a tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). Every message must include a MessageGroupId.
    
    Parameters:
    
    messageGroupId -
    This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    The MessageGroupId is a tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). Every message must include a MessageGroupId.
  - withMessageGroupId
```
public PublishRequest withMessageGroupId(java.lang.String messageGroupId)
```
    This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    The MessageGroupId is a tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). Every message must include a MessageGroupId.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    messageGroupId -
    This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    The MessageGroupId is a tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). Every message must include a MessageGroupId.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class PublishRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

PublishRequest

PublishRequest

PublishRequest

Method Detail

getTopicArn

setTopicArn

withTopicArn

getTargetArn

setTargetArn

withTargetArn

getPhoneNumber

setPhoneNumber

withPhoneNumber

getMessage

setMessage

withMessage

getSubject

setSubject

withSubject

getMessageStructure

setMessageStructure

withMessageStructure

getMessageAttributes

setMessageAttributes

withMessageAttributes

addMessageAttributesEntry

clearMessageAttributesEntries

getMessageDeduplicationId

setMessageDeduplicationId

withMessageDeduplicationId

getMessageGroupId

setMessageGroupId

withMessageGroupId

toString

hashCode

equals