Package software.amazon.awssdk.services.sns.model

Class MessageAttributeValue

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

The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see Publish.

Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see Amazon SNS message attributes and Publishing to a mobile phone in the Amazon SNS Developer Guide.

See Also:

  • Method Details

    • dataType

      public final String dataType()

      Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see Message Attribute Data Types.

      Returns:
      Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see Message Attribute Data Types.

    • stringValue

      public final String stringValue()

      Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters.

      Returns:
      Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters.

    • binaryValue

      public final SdkBytes binaryValue()

      Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.

      Returns:
      Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.

    • toBuilder

      public MessageAttributeValue.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<MessageAttributeValue.Builder,MessageAttributeValue>
      Returns:
      a builder for type T

    • builder

      public static MessageAttributeValue.Builder builder()

    • serializableBuilderClass

      public static Class<? extends MessageAttributeValue.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.