SnsAction (AWS SDK for Android

java.lang.Object
- com.amazonaws.services.iot.model.SnsAction

All Implemented Interfaces:

java.io.Serializable
```
public class SnsAction
extends java.lang.Object
implements java.io.Serializable
```
Describes an action to publish to an Amazon SNS topic.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

SnsAction()

Constructors
Constructor and Description
`SnsAction()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getMessageFormat()` (Optional) The message format of the message to publish.
`java.lang.String`	`getRoleArn()` The ARN of the IAM role that grants access.
`java.lang.String`	`getTargetArn()` The ARN of the SNS topic.
`int`	`hashCode()`
`void`	`setMessageFormat(MessageFormat messageFormat)` (Optional) The message format of the message to publish.
`void`	`setMessageFormat(java.lang.String messageFormat)` (Optional) The message format of the message to publish.
`void`	`setRoleArn(java.lang.String roleArn)` The ARN of the IAM role that grants access.
`void`	`setTargetArn(java.lang.String targetArn)` The ARN of the SNS topic.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`SnsAction`	`withMessageFormat(MessageFormat messageFormat)` (Optional) The message format of the message to publish.
`SnsAction`	`withMessageFormat(java.lang.String messageFormat)` (Optional) The message format of the message to publish.
`SnsAction`	`withRoleArn(java.lang.String roleArn)` The ARN of the IAM role that grants access.
`SnsAction`	`withTargetArn(java.lang.String targetArn)` The ARN of the SNS topic.

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

- Constructor Detail
  - SnsAction
```
public SnsAction()
```
- Method Detail
  - getTargetArn
```
public java.lang.String getTargetArn()
```
    The ARN of the SNS topic.
    
    Returns:
    
    The ARN of the SNS topic.
  - setTargetArn
```
public void setTargetArn(java.lang.String targetArn)
```
    The ARN of the SNS topic.
    
    Parameters:
    
    targetArn -
    The ARN of the SNS topic.
  - withTargetArn
```
public SnsAction withTargetArn(java.lang.String targetArn)
```
    The ARN of the SNS topic.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    targetArn -
    The ARN of the SNS topic.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getRoleArn
```
public java.lang.String getRoleArn()
```
    The ARN of the IAM role that grants access.
    
    Returns:
    
    The ARN of the IAM role that grants access.
  - setRoleArn
```
public void setRoleArn(java.lang.String roleArn)
```
    The ARN of the IAM role that grants access.
    
    Parameters:
    
    roleArn -
    The ARN of the IAM role that grants access.
  - withRoleArn
```
public SnsAction withRoleArn(java.lang.String roleArn)
```
    The ARN of the IAM role that grants access.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    roleArn -
    The ARN of the IAM role that grants access.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMessageFormat
```
public java.lang.String getMessageFormat()
```
    (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
    
    Constraints:
    Allowed Values: RAW, JSON
    
    Returns:
    
    (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
    
    See Also:
    
    MessageFormat
  - setMessageFormat
```
public void setMessageFormat(java.lang.String messageFormat)
```
    (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
    
    Constraints:
    Allowed Values: RAW, JSON
    
    Parameters:
    
    messageFormat -
    (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https ://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
    
    See Also:
    
    MessageFormat
  - withMessageFormat
```
public SnsAction withMessageFormat(java.lang.String messageFormat)
```
    (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: RAW, JSON
    
    Parameters:
    
    messageFormat -
    (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https ://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    MessageFormat
  - setMessageFormat
```
public void setMessageFormat(MessageFormat messageFormat)
```
    (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
    
    Constraints:
    Allowed Values: RAW, JSON
    
    Parameters:
    
    messageFormat -
    (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https ://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
    
    See Also:
    
    MessageFormat
  - withMessageFormat
```
public SnsAction withMessageFormat(MessageFormat messageFormat)
```
    (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: RAW, JSON
    
    Parameters:
    
    messageFormat -
    (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https ://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    MessageFormat
  - 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 SnsAction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SnsAction

Method Detail

getTargetArn

setTargetArn

withTargetArn

getRoleArn

setRoleArn

withRoleArn

getMessageFormat

setMessageFormat

withMessageFormat

setMessageFormat

withMessageFormat

toString

hashCode

equals