AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::SQS::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::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)
 
const Aws::Vector< Aws::String > & GetStringListValues () const
 
bool StringListValuesHasBeenSet () const
 
void SetStringListValues (const Aws::Vector< Aws::String > &value)
 
void SetStringListValues (Aws::Vector< Aws::String > &&value)
 
MessageAttributeValueWithStringListValues (const Aws::Vector< Aws::String > &value)
 
MessageAttributeValueWithStringListValues (Aws::Vector< Aws::String > &&value)
 
MessageAttributeValueAddStringListValues (const Aws::String &value)
 
MessageAttributeValueAddStringListValues (Aws::String &&value)
 
MessageAttributeValueAddStringListValues (const char *value)
 
const Aws::Vector< Aws::Utils::ByteBuffer > & GetBinaryListValues () const
 
bool BinaryListValuesHasBeenSet () const
 
void SetBinaryListValues (const Aws::Vector< Aws::Utils::ByteBuffer > &value)
 
void SetBinaryListValues (Aws::Vector< Aws::Utils::ByteBuffer > &&value)
 
MessageAttributeValueWithBinaryListValues (const Aws::Vector< Aws::Utils::ByteBuffer > &value)
 
MessageAttributeValueWithBinaryListValues (Aws::Vector< Aws::Utils::ByteBuffer > &&value)
 
MessageAttributeValueAddBinaryListValues (const Aws::Utils::ByteBuffer &value)
 
MessageAttributeValueAddBinaryListValues (Aws::Utils::ByteBuffer &&value)
 
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)
 

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 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 KB or 262,144 bytes).

See Also:

AWS API Reference

Definition at line 40 of file MessageAttributeValue.h.

Constructor & Destructor Documentation

◆ MessageAttributeValue() [1/2]

Aws::SQS::Model::MessageAttributeValue::MessageAttributeValue ( )

◆ MessageAttributeValue() [2/2]

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

Member Function Documentation

◆ AddBinaryListValues() [1/2]

MessageAttributeValue& Aws::SQS::Model::MessageAttributeValue::AddBinaryListValues ( const Aws::Utils::ByteBuffer value)
inline

Not implemented. Reserved for future use.

Definition at line 232 of file MessageAttributeValue.h.

◆ AddBinaryListValues() [2/2]

MessageAttributeValue& Aws::SQS::Model::MessageAttributeValue::AddBinaryListValues ( Aws::Utils::ByteBuffer &&  value)
inline

Not implemented. Reserved for future use.

Definition at line 237 of file MessageAttributeValue.h.

◆ AddStringListValues() [1/3]

MessageAttributeValue& Aws::SQS::Model::MessageAttributeValue::AddStringListValues ( const Aws::String value)
inline

Not implemented. Reserved for future use.

Definition at line 186 of file MessageAttributeValue.h.

◆ AddStringListValues() [2/3]

MessageAttributeValue& Aws::SQS::Model::MessageAttributeValue::AddStringListValues ( Aws::String &&  value)
inline

Not implemented. Reserved for future use.

Definition at line 191 of file MessageAttributeValue.h.

◆ AddStringListValues() [3/3]

MessageAttributeValue& Aws::SQS::Model::MessageAttributeValue::AddStringListValues ( const char *  value)
inline

Not implemented. Reserved for future use.

Definition at line 196 of file MessageAttributeValue.h.

◆ BinaryListValuesHasBeenSet()

bool Aws::SQS::Model::MessageAttributeValue::BinaryListValuesHasBeenSet ( ) const
inline

Not implemented. Reserved for future use.

Definition at line 207 of file MessageAttributeValue.h.

◆ BinaryValueHasBeenSet()

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

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

Definition at line 126 of file MessageAttributeValue.h.

◆ DataTypeHasBeenSet()

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

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 Simple Queue Service Developer Guide.

Definition at line 260 of file MessageAttributeValue.h.

◆ GetBinaryListValues()

const Aws::Vector<Aws::Utils::ByteBuffer>& Aws::SQS::Model::MessageAttributeValue::GetBinaryListValues ( ) const
inline

Not implemented. Reserved for future use.

Definition at line 202 of file MessageAttributeValue.h.

◆ GetBinaryValue()

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

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

Definition at line 120 of file MessageAttributeValue.h.

◆ GetDataType()

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

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 Simple Queue Service Developer Guide.

Definition at line 249 of file MessageAttributeValue.h.

◆ GetStringListValues()

const Aws::Vector<Aws::String>& Aws::SQS::Model::MessageAttributeValue::GetStringListValues ( ) const
inline

Not implemented. Reserved for future use.

Definition at line 156 of file MessageAttributeValue.h.

◆ GetStringValue()

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

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

Definition at line 57 of file MessageAttributeValue.h.

◆ operator=()

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

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

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

◆ SetBinaryListValues() [1/2]

void Aws::SQS::Model::MessageAttributeValue::SetBinaryListValues ( const Aws::Vector< Aws::Utils::ByteBuffer > &  value)
inline

Not implemented. Reserved for future use.

Definition at line 212 of file MessageAttributeValue.h.

◆ SetBinaryListValues() [2/2]

void Aws::SQS::Model::MessageAttributeValue::SetBinaryListValues ( Aws::Vector< Aws::Utils::ByteBuffer > &&  value)
inline

Not implemented. Reserved for future use.

Definition at line 217 of file MessageAttributeValue.h.

◆ SetBinaryValue() [1/2]

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

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

Definition at line 132 of file MessageAttributeValue.h.

◆ SetBinaryValue() [2/2]

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

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

Definition at line 138 of file MessageAttributeValue.h.

◆ SetDataType() [1/3]

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

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 Simple Queue Service Developer Guide.

Definition at line 271 of file MessageAttributeValue.h.

◆ SetDataType() [2/3]

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

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 Simple Queue Service Developer Guide.

Definition at line 282 of file MessageAttributeValue.h.

◆ SetDataType() [3/3]

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

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 Simple Queue Service Developer Guide.

Definition at line 293 of file MessageAttributeValue.h.

◆ SetStringListValues() [1/2]

void Aws::SQS::Model::MessageAttributeValue::SetStringListValues ( const Aws::Vector< Aws::String > &  value)
inline

Not implemented. Reserved for future use.

Definition at line 166 of file MessageAttributeValue.h.

◆ SetStringListValues() [2/2]

void Aws::SQS::Model::MessageAttributeValue::SetStringListValues ( Aws::Vector< Aws::String > &&  value)
inline

Not implemented. Reserved for future use.

Definition at line 171 of file MessageAttributeValue.h.

◆ SetStringValue() [1/3]

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

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

Definition at line 73 of file MessageAttributeValue.h.

◆ SetStringValue() [2/3]

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

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

Definition at line 81 of file MessageAttributeValue.h.

◆ SetStringValue() [3/3]

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

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

Definition at line 89 of file MessageAttributeValue.h.

◆ StringListValuesHasBeenSet()

bool Aws::SQS::Model::MessageAttributeValue::StringListValuesHasBeenSet ( ) const
inline

Not implemented. Reserved for future use.

Definition at line 161 of file MessageAttributeValue.h.

◆ StringValueHasBeenSet()

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

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

Definition at line 65 of file MessageAttributeValue.h.

◆ WithBinaryListValues() [1/2]

MessageAttributeValue& Aws::SQS::Model::MessageAttributeValue::WithBinaryListValues ( const Aws::Vector< Aws::Utils::ByteBuffer > &  value)
inline

Not implemented. Reserved for future use.

Definition at line 222 of file MessageAttributeValue.h.

◆ WithBinaryListValues() [2/2]

MessageAttributeValue& Aws::SQS::Model::MessageAttributeValue::WithBinaryListValues ( Aws::Vector< Aws::Utils::ByteBuffer > &&  value)
inline

Not implemented. Reserved for future use.

Definition at line 227 of file MessageAttributeValue.h.

◆ WithBinaryValue() [1/2]

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

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

Definition at line 144 of file MessageAttributeValue.h.

◆ WithBinaryValue() [2/2]

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

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

Definition at line 150 of file MessageAttributeValue.h.

◆ WithDataType() [1/3]

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

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 Simple Queue Service Developer Guide.

Definition at line 304 of file MessageAttributeValue.h.

◆ WithDataType() [2/3]

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

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 Simple Queue Service Developer Guide.

Definition at line 315 of file MessageAttributeValue.h.

◆ WithDataType() [3/3]

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

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 Simple Queue Service Developer Guide.

Definition at line 326 of file MessageAttributeValue.h.

◆ WithStringListValues() [1/2]

MessageAttributeValue& Aws::SQS::Model::MessageAttributeValue::WithStringListValues ( const Aws::Vector< Aws::String > &  value)
inline

Not implemented. Reserved for future use.

Definition at line 176 of file MessageAttributeValue.h.

◆ WithStringListValues() [2/2]

MessageAttributeValue& Aws::SQS::Model::MessageAttributeValue::WithStringListValues ( Aws::Vector< Aws::String > &&  value)
inline

Not implemented. Reserved for future use.

Definition at line 181 of file MessageAttributeValue.h.

◆ WithStringValue() [1/3]

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

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

Definition at line 97 of file MessageAttributeValue.h.

◆ WithStringValue() [2/3]

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

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

Definition at line 105 of file MessageAttributeValue.h.

◆ WithStringValue() [3/3]

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

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

Definition at line 113 of file MessageAttributeValue.h.


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