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 256 KiB (262,144 bytes) by default and is determined by the topic's MaximumMessageSize attribute. For more information, see Large message payloads, Amazon SNS message attributes and Publishing to a mobile phone in the Amazon SNS Developer Guide.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MessageAttributeValue.Builder

Method Summary

Modifier and Type	Method	Description
final SdkBytes	binaryValue()	Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
static MessageAttributeValue.Builder	builder()
final String	dataType()	Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends MessageAttributeValue.Builder>	serializableBuilderClass()
final String	stringValue()	Strings are Unicode with UTF8 binary encoding.
MessageAttributeValue.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

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

Specified by:

toBuilder in interface ToCopyableBuilder<MessageAttributeValue.Builder,MessageAttributeValue>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo