AWS SDK for C++  1.9.104
AWS SDK for C++
Public Member Functions | List of all members
Aws::SNS::Model::MessageAttributeValue Class Reference

#include <MessageAttributeValue.h>

Public Member Functions

 MessageAttributeValue ()
 
 MessageAttributeValue (const Aws::Utils::Xml::XmlNode &xmlNode)
 
MessageAttributeValueoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const Aws::StringGetDataType () const
 
bool DataTypeHasBeenSet () const
 
void SetDataType (const Aws::String &value)
 
void SetDataType (Aws::String &&value)
 
void SetDataType (const char *value)
 
MessageAttributeValueWithDataType (const Aws::String &value)
 
MessageAttributeValueWithDataType (Aws::String &&value)
 
MessageAttributeValueWithDataType (const char *value)
 
const Aws::StringGetStringValue () const
 
bool StringValueHasBeenSet () const
 
void SetStringValue (const Aws::String &value)
 
void SetStringValue (Aws::String &&value)
 
void SetStringValue (const char *value)
 
MessageAttributeValueWithStringValue (const Aws::String &value)
 
MessageAttributeValueWithStringValue (Aws::String &&value)
 
MessageAttributeValueWithStringValue (const char *value)
 
const Aws::Utils::ByteBufferGetBinaryValue () const
 
bool BinaryValueHasBeenSet () const
 
void SetBinaryValue (const Aws::Utils::ByteBuffer &value)
 
void SetBinaryValue (Aws::Utils::ByteBuffer &&value)
 
MessageAttributeValueWithBinaryValue (const Aws::Utils::ByteBuffer &value)
 
MessageAttributeValueWithBinaryValue (Aws::Utils::ByteBuffer &&value)
 

Detailed Description

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:

AWS API Reference

Definition at line 44 of file MessageAttributeValue.h.

Constructor & Destructor Documentation

◆ MessageAttributeValue() [1/2]

Aws::SNS::Model::MessageAttributeValue::MessageAttributeValue ( )

◆ MessageAttributeValue() [2/2]

Aws::SNS::Model::MessageAttributeValue::MessageAttributeValue ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ BinaryValueHasBeenSet()

bool Aws::SNS::Model::MessageAttributeValue::BinaryValueHasBeenSet ( ) const
inline

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

Definition at line 187 of file MessageAttributeValue.h.

◆ DataTypeHasBeenSet()

bool Aws::SNS::Model::MessageAttributeValue::DataTypeHasBeenSet ( ) const
inline

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

Definition at line 69 of file MessageAttributeValue.h.

◆ GetBinaryValue()

const Aws::Utils::ByteBuffer& Aws::SNS::Model::MessageAttributeValue::GetBinaryValue ( ) const
inline

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

Definition at line 181 of file MessageAttributeValue.h.

◆ GetDataType()

const Aws::String& Aws::SNS::Model::MessageAttributeValue::GetDataType ( ) const
inline

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

Definition at line 61 of file MessageAttributeValue.h.

◆ GetStringValue()

const Aws::String& Aws::SNS::Model::MessageAttributeValue::GetStringValue ( ) const
inline

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

Definition at line 125 of file MessageAttributeValue.h.

◆ operator=()

MessageAttributeValue& Aws::SNS::Model::MessageAttributeValue::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::SNS::Model::MessageAttributeValue::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

void Aws::SNS::Model::MessageAttributeValue::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ SetBinaryValue() [1/2]

void Aws::SNS::Model::MessageAttributeValue::SetBinaryValue ( Aws::Utils::ByteBuffer &&  value)
inline

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

Definition at line 199 of file MessageAttributeValue.h.

◆ SetBinaryValue() [2/2]

void Aws::SNS::Model::MessageAttributeValue::SetBinaryValue ( const Aws::Utils::ByteBuffer value)
inline

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

Definition at line 193 of file MessageAttributeValue.h.

◆ SetDataType() [1/3]

void Aws::SNS::Model::MessageAttributeValue::SetDataType ( Aws::String &&  value)
inline

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

Definition at line 85 of file MessageAttributeValue.h.

◆ SetDataType() [2/3]

void Aws::SNS::Model::MessageAttributeValue::SetDataType ( const Aws::String value)
inline

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

Definition at line 77 of file MessageAttributeValue.h.

◆ SetDataType() [3/3]

void Aws::SNS::Model::MessageAttributeValue::SetDataType ( const char *  value)
inline

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

Definition at line 93 of file MessageAttributeValue.h.

◆ SetStringValue() [1/3]

void Aws::SNS::Model::MessageAttributeValue::SetStringValue ( Aws::String &&  value)
inline

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

Definition at line 146 of file MessageAttributeValue.h.

◆ SetStringValue() [2/3]

void Aws::SNS::Model::MessageAttributeValue::SetStringValue ( const Aws::String value)
inline

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

Definition at line 139 of file MessageAttributeValue.h.

◆ SetStringValue() [3/3]

void Aws::SNS::Model::MessageAttributeValue::SetStringValue ( const char *  value)
inline

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

Definition at line 153 of file MessageAttributeValue.h.

◆ StringValueHasBeenSet()

bool Aws::SNS::Model::MessageAttributeValue::StringValueHasBeenSet ( ) const
inline

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

Definition at line 132 of file MessageAttributeValue.h.

◆ WithBinaryValue() [1/2]

MessageAttributeValue& Aws::SNS::Model::MessageAttributeValue::WithBinaryValue ( Aws::Utils::ByteBuffer &&  value)
inline

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

Definition at line 211 of file MessageAttributeValue.h.

◆ WithBinaryValue() [2/2]

MessageAttributeValue& Aws::SNS::Model::MessageAttributeValue::WithBinaryValue ( const Aws::Utils::ByteBuffer value)
inline

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

Definition at line 205 of file MessageAttributeValue.h.

◆ WithDataType() [1/3]

MessageAttributeValue& Aws::SNS::Model::MessageAttributeValue::WithDataType ( Aws::String &&  value)
inline

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

Definition at line 109 of file MessageAttributeValue.h.

◆ WithDataType() [2/3]

MessageAttributeValue& Aws::SNS::Model::MessageAttributeValue::WithDataType ( const Aws::String value)
inline

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

Definition at line 101 of file MessageAttributeValue.h.

◆ WithDataType() [3/3]

MessageAttributeValue& Aws::SNS::Model::MessageAttributeValue::WithDataType ( const char *  value)
inline

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

Definition at line 117 of file MessageAttributeValue.h.

◆ WithStringValue() [1/3]

MessageAttributeValue& Aws::SNS::Model::MessageAttributeValue::WithStringValue ( Aws::String &&  value)
inline

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

Definition at line 167 of file MessageAttributeValue.h.

◆ WithStringValue() [2/3]

MessageAttributeValue& Aws::SNS::Model::MessageAttributeValue::WithStringValue ( const Aws::String value)
inline

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

Definition at line 160 of file MessageAttributeValue.h.

◆ WithStringValue() [3/3]

MessageAttributeValue& Aws::SNS::Model::MessageAttributeValue::WithStringValue ( const char *  value)
inline

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

Definition at line 174 of file MessageAttributeValue.h.


The documentation for this class was generated from the following file: