Class SnsAction

java.lang.Object
software.amazon.awssdk.services.iot.model.SnsAction
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SnsAction.Builder,SnsAction>
@Generated("software.amazon.awssdk:codegen") public final class SnsAction extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SnsAction.Builder,SnsAction>

Describes an action to publish to an Amazon SNS topic.

See Also:

  • Method Details

    • targetArn

      public final String targetArn()

      The ARN of the SNS topic.

      Returns:
      The ARN of the SNS topic.

    • roleArn

      public final String roleArn()

      The ARN of the IAM role that grants access.

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

    • messageFormat

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, messageFormat will return MessageFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageFormatAsString().

      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:

    • messageFormatAsString

      public final String messageFormatAsString()

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

      If the service returns an enum value that is not available in the current SDK version, messageFormat will return MessageFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageFormatAsString().

      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:

    • toBuilder

      public SnsAction.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SnsAction.Builder,SnsAction>
      Returns:
      a builder for type T

    • builder

      public static SnsAction.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SnsAction.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.