AWS SDK for C++  1.9.158
AWS SDK for C++
Public Member Functions | List of all members
Aws::IoT::Model::AttributePayload Class Reference

#include <AttributePayload.h>

Public Member Functions

 AttributePayload ()
 
 AttributePayload (Aws::Utils::Json::JsonView jsonValue)
 
AttributePayloadoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::Map< Aws::String, Aws::String > & GetAttributes () const
 
bool AttributesHasBeenSet () const
 
void SetAttributes (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetAttributes (Aws::Map< Aws::String, Aws::String > &&value)
 
AttributePayloadWithAttributes (const Aws::Map< Aws::String, Aws::String > &value)
 
AttributePayloadWithAttributes (Aws::Map< Aws::String, Aws::String > &&value)
 
AttributePayloadAddAttributes (const Aws::String &key, const Aws::String &value)
 
AttributePayloadAddAttributes (Aws::String &&key, const Aws::String &value)
 
AttributePayloadAddAttributes (const Aws::String &key, Aws::String &&value)
 
AttributePayloadAddAttributes (Aws::String &&key, Aws::String &&value)
 
AttributePayloadAddAttributes (const char *key, Aws::String &&value)
 
AttributePayloadAddAttributes (Aws::String &&key, const char *value)
 
AttributePayloadAddAttributes (const char *key, const char *value)
 
bool GetMerge () const
 
bool MergeHasBeenSet () const
 
void SetMerge (bool value)
 
AttributePayloadWithMerge (bool value)
 

Detailed Description

The attribute payload.

See Also:

AWS API Reference

Definition at line 32 of file AttributePayload.h.

Constructor & Destructor Documentation

◆ AttributePayload() [1/2]

Aws::IoT::Model::AttributePayload::AttributePayload ( )

◆ AttributePayload() [2/2]

Aws::IoT::Model::AttributePayload::AttributePayload ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddAttributes() [1/7]

AttributePayload& Aws::IoT::Model::AttributePayload::AddAttributes ( Aws::String &&  key,
Aws::String &&  value 
)
inline

A JSON string containing up to three key-value pair in JSON format. For example:

{"attributes":{"string1":"string2"}}

Definition at line 99 of file AttributePayload.h.

◆ AddAttributes() [2/7]

AttributePayload& Aws::IoT::Model::AttributePayload::AddAttributes ( Aws::String &&  key,
const Aws::String value 
)
inline

A JSON string containing up to three key-value pair in JSON format. For example:

{"attributes":{"string1":"string2"}}

Definition at line 87 of file AttributePayload.h.

◆ AddAttributes() [3/7]

AttributePayload& Aws::IoT::Model::AttributePayload::AddAttributes ( Aws::String &&  key,
const char *  value 
)
inline

A JSON string containing up to three key-value pair in JSON format. For example:

{"attributes":{"string1":"string2"}}

Definition at line 111 of file AttributePayload.h.

◆ AddAttributes() [4/7]

AttributePayload& Aws::IoT::Model::AttributePayload::AddAttributes ( const Aws::String key,
Aws::String &&  value 
)
inline

A JSON string containing up to three key-value pair in JSON format. For example:

{"attributes":{"string1":"string2"}}

Definition at line 93 of file AttributePayload.h.

◆ AddAttributes() [5/7]

AttributePayload& Aws::IoT::Model::AttributePayload::AddAttributes ( const Aws::String key,
const Aws::String value 
)
inline

A JSON string containing up to three key-value pair in JSON format. For example:

{"attributes":{"string1":"string2"}}

Definition at line 81 of file AttributePayload.h.

◆ AddAttributes() [6/7]

AttributePayload& Aws::IoT::Model::AttributePayload::AddAttributes ( const char *  key,
Aws::String &&  value 
)
inline

A JSON string containing up to three key-value pair in JSON format. For example:

{"attributes":{"string1":"string2"}}

Definition at line 105 of file AttributePayload.h.

◆ AddAttributes() [7/7]

AttributePayload& Aws::IoT::Model::AttributePayload::AddAttributes ( const char *  key,
const char *  value 
)
inline

A JSON string containing up to three key-value pair in JSON format. For example:

{"attributes":{"string1":"string2"}}

Definition at line 117 of file AttributePayload.h.

◆ AttributesHasBeenSet()

bool Aws::IoT::Model::AttributePayload::AttributesHasBeenSet ( ) const
inline

A JSON string containing up to three key-value pair in JSON format. For example:

{"attributes":{"string1":"string2"}}

Definition at line 51 of file AttributePayload.h.

◆ GetAttributes()

const Aws::Map<Aws::String, Aws::String>& Aws::IoT::Model::AttributePayload::GetAttributes ( ) const
inline

A JSON string containing up to three key-value pair in JSON format. For example:

{"attributes":{"string1":"string2"}}

Definition at line 45 of file AttributePayload.h.

◆ GetMerge()

bool Aws::IoT::Model::AttributePayload::GetMerge ( ) const
inline

Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.

To remove an attribute, call UpdateThing with an empty attribute value.

The merge attribute is only valid when calling UpdateThing or UpdateThingGroup.

Definition at line 128 of file AttributePayload.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::IoT::Model::AttributePayload::Jsonize ( ) const

◆ MergeHasBeenSet()

bool Aws::IoT::Model::AttributePayload::MergeHasBeenSet ( ) const
inline

Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.

To remove an attribute, call UpdateThing with an empty attribute value.

The merge attribute is only valid when calling UpdateThing or UpdateThingGroup.

Definition at line 138 of file AttributePayload.h.

◆ operator=()

AttributePayload& Aws::IoT::Model::AttributePayload::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetAttributes() [1/2]

void Aws::IoT::Model::AttributePayload::SetAttributes ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A JSON string containing up to three key-value pair in JSON format. For example:

{"attributes":{"string1":"string2"}}

Definition at line 63 of file AttributePayload.h.

◆ SetAttributes() [2/2]

void Aws::IoT::Model::AttributePayload::SetAttributes ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A JSON string containing up to three key-value pair in JSON format. For example:

{"attributes":{"string1":"string2"}}

Definition at line 57 of file AttributePayload.h.

◆ SetMerge()

void Aws::IoT::Model::AttributePayload::SetMerge ( bool  value)
inline

Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.

To remove an attribute, call UpdateThing with an empty attribute value.

The merge attribute is only valid when calling UpdateThing or UpdateThingGroup.

Definition at line 148 of file AttributePayload.h.

◆ WithAttributes() [1/2]

AttributePayload& Aws::IoT::Model::AttributePayload::WithAttributes ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A JSON string containing up to three key-value pair in JSON format. For example:

{"attributes":{"string1":"string2"}}

Definition at line 75 of file AttributePayload.h.

◆ WithAttributes() [2/2]

AttributePayload& Aws::IoT::Model::AttributePayload::WithAttributes ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A JSON string containing up to three key-value pair in JSON format. For example:

{"attributes":{"string1":"string2"}}

Definition at line 69 of file AttributePayload.h.

◆ WithMerge()

AttributePayload& Aws::IoT::Model::AttributePayload::WithMerge ( bool  value)
inline

Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.

To remove an attribute, call UpdateThing with an empty attribute value.

The merge attribute is only valid when calling UpdateThing or UpdateThingGroup.

Definition at line 158 of file AttributePayload.h.


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