Class MessageAttributeValue
- All Implemented Interfaces:
Serializable
,SdkPojo
,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 SendMessage.
Name
, type
, value
and the message body must not be empty or null. All parts of
the message attribute, including Name
, Type
, and Value
, are part of the
message size restriction (256 KiB or 262,144 bytes).
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionNot implemented.final SdkBytes
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.builder()
final String
dataType()
Amazon SQS supports the following logical data types:String
,Number
, andBinary
.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the BinaryListValues property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the StringListValues property.static Class
<? extends MessageAttributeValue.Builder> Not implemented.final String
Strings are Unicode with UTF-8 binary encoding.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 theisEmpty()
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
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 theisEmpty()
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
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
Amazon SQS supports the following logical data types:
String
,Number
, andBinary
. For theNumber
data type, you must useStringValue
.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
, andBinary
. For theNumber
data type, you must useStringValue
.You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.
-
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 interfaceToCopyableBuilder<MessageAttributeValue.Builder,
MessageAttributeValue> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-