Class SnsAction

java.lang.Object
com.amazonaws.services.iot.model.SnsAction
All Implemented Interfaces:
Serializable, Cloneable

public class SnsAction extends Object implements Serializable, Cloneable

Describes an action to publish to an Amazon SNS topic.

See Also:
  • Constructor Details

    • SnsAction

      public SnsAction()
  • Method Details

    • setTargetArn

      public void setTargetArn(String targetArn)

      The ARN of the SNS topic.

      Parameters:
      targetArn - The ARN of the SNS topic.
    • getTargetArn

      public String getTargetArn()

      The ARN of the SNS topic.

      Returns:
      The ARN of the SNS topic.
    • withTargetArn

      public SnsAction withTargetArn(String targetArn)

      The ARN of the SNS topic.

      Parameters:
      targetArn - The ARN of the SNS topic.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setRoleArn

      public void setRoleArn(String roleArn)

      The ARN of the IAM role that grants access.

      Parameters:
      roleArn - The ARN of the IAM role that grants access.
    • getRoleArn

      public String getRoleArn()

      The ARN of the IAM role that grants access.

      Returns:
      The ARN of the IAM role that grants access.
    • withRoleArn

      public SnsAction withRoleArn(String roleArn)

      The ARN of the IAM role that grants access.

      Parameters:
      roleArn - The ARN of the IAM role that grants access.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setMessageFormat

      public void setMessageFormat(String messageFormat)

      The message format of the message to publish. Optional. 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 refer to their official documentation.

      Parameters:
      messageFormat - The message format of the message to publish. Optional. 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 refer to their official documentation.
      See Also:
    • getMessageFormat

      public String getMessageFormat()

      The message format of the message to publish. Optional. 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 refer to their official documentation.

      Returns:
      The message format of the message to publish. Optional. 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 refer to their official documentation.
      See Also:
    • withMessageFormat

      public SnsAction withMessageFormat(String messageFormat)

      The message format of the message to publish. Optional. 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 refer to their official documentation.

      Parameters:
      messageFormat - The message format of the message to publish. Optional. 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 refer to their official documentation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setMessageFormat

      public void setMessageFormat(MessageFormat messageFormat)

      The message format of the message to publish. Optional. 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 refer to their official documentation.

      Parameters:
      messageFormat - The message format of the message to publish. Optional. 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 refer to their official documentation.
      See Also:
    • withMessageFormat

      public SnsAction withMessageFormat(MessageFormat messageFormat)

      The message format of the message to publish. Optional. 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 refer to their official documentation.

      Parameters:
      messageFormat - The message format of the message to publish. Optional. 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 refer to their official documentation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public SnsAction clone()
      Overrides:
      clone in class Object