Class MessageSystemAttributeValue

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

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

Name, type, value and the message body must not be empty or null.

See Also:

  • Method Details

    • stringValue

      public final String stringValue()

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

      Returns:
      Strings are Unicode with UTF-8 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, such as compressed data, encrypted data, or images.

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

    • hasStringListValues

      public final boolean hasStringListValues()
      For responses, this returns true if the service returned a value for the StringListValues property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • stringListValues

      public final List<String> stringListValues()

      Not implemented. Reserved for future use.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStringListValues() method.

      Returns:
      Not implemented. Reserved for future use.

    • hasBinaryListValues

      public final boolean hasBinaryListValues()
      For responses, this returns true if the service returned a value for the BinaryListValues property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • binaryListValues

      public final List<SdkBytes> binaryListValues()

      Not implemented. Reserved for future use.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBinaryListValues() method.

      Returns:
      Not implemented. Reserved for future use.

    • dataType

      public final String dataType()

      Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

      You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.

      Returns:
      Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

      You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.

    • toBuilder

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

    • builder

      public static MessageSystemAttributeValue.Builder builder()

    • serializableBuilderClass

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