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

#include <DescribeThingResult.h>

Public Member Functions

 DescribeThingResult ()
 
 DescribeThingResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
DescribeThingResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetDefaultClientId () const
 
void SetDefaultClientId (const Aws::String &value)
 
void SetDefaultClientId (Aws::String &&value)
 
void SetDefaultClientId (const char *value)
 
DescribeThingResultWithDefaultClientId (const Aws::String &value)
 
DescribeThingResultWithDefaultClientId (Aws::String &&value)
 
DescribeThingResultWithDefaultClientId (const char *value)
 
const Aws::StringGetThingName () const
 
void SetThingName (const Aws::String &value)
 
void SetThingName (Aws::String &&value)
 
void SetThingName (const char *value)
 
DescribeThingResultWithThingName (const Aws::String &value)
 
DescribeThingResultWithThingName (Aws::String &&value)
 
DescribeThingResultWithThingName (const char *value)
 
const Aws::StringGetThingId () const
 
void SetThingId (const Aws::String &value)
 
void SetThingId (Aws::String &&value)
 
void SetThingId (const char *value)
 
DescribeThingResultWithThingId (const Aws::String &value)
 
DescribeThingResultWithThingId (Aws::String &&value)
 
DescribeThingResultWithThingId (const char *value)
 
const Aws::StringGetThingArn () const
 
void SetThingArn (const Aws::String &value)
 
void SetThingArn (Aws::String &&value)
 
void SetThingArn (const char *value)
 
DescribeThingResultWithThingArn (const Aws::String &value)
 
DescribeThingResultWithThingArn (Aws::String &&value)
 
DescribeThingResultWithThingArn (const char *value)
 
const Aws::StringGetThingTypeName () const
 
void SetThingTypeName (const Aws::String &value)
 
void SetThingTypeName (Aws::String &&value)
 
void SetThingTypeName (const char *value)
 
DescribeThingResultWithThingTypeName (const Aws::String &value)
 
DescribeThingResultWithThingTypeName (Aws::String &&value)
 
DescribeThingResultWithThingTypeName (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetAttributes () const
 
void SetAttributes (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetAttributes (Aws::Map< Aws::String, Aws::String > &&value)
 
DescribeThingResultWithAttributes (const Aws::Map< Aws::String, Aws::String > &value)
 
DescribeThingResultWithAttributes (Aws::Map< Aws::String, Aws::String > &&value)
 
DescribeThingResultAddAttributes (const Aws::String &key, const Aws::String &value)
 
DescribeThingResultAddAttributes (Aws::String &&key, const Aws::String &value)
 
DescribeThingResultAddAttributes (const Aws::String &key, Aws::String &&value)
 
DescribeThingResultAddAttributes (Aws::String &&key, Aws::String &&value)
 
DescribeThingResultAddAttributes (const char *key, Aws::String &&value)
 
DescribeThingResultAddAttributes (Aws::String &&key, const char *value)
 
DescribeThingResultAddAttributes (const char *key, const char *value)
 
long long GetVersion () const
 
void SetVersion (long long value)
 
DescribeThingResultWithVersion (long long value)
 
const Aws::StringGetBillingGroupName () const
 
void SetBillingGroupName (const Aws::String &value)
 
void SetBillingGroupName (Aws::String &&value)
 
void SetBillingGroupName (const char *value)
 
DescribeThingResultWithBillingGroupName (const Aws::String &value)
 
DescribeThingResultWithBillingGroupName (Aws::String &&value)
 
DescribeThingResultWithBillingGroupName (const char *value)
 

Detailed Description

The output from the DescribeThing operation.

See Also:

AWS API Reference

Definition at line 33 of file DescribeThingResult.h.

Constructor & Destructor Documentation

◆ DescribeThingResult() [1/2]

Aws::IoT::Model::DescribeThingResult::DescribeThingResult ( )

◆ DescribeThingResult() [2/2]

Aws::IoT::Model::DescribeThingResult::DescribeThingResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ AddAttributes() [1/7]

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

The thing attributes.

Definition at line 306 of file DescribeThingResult.h.

◆ AddAttributes() [2/7]

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

The thing attributes.

Definition at line 296 of file DescribeThingResult.h.

◆ AddAttributes() [3/7]

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

The thing attributes.

Definition at line 316 of file DescribeThingResult.h.

◆ AddAttributes() [4/7]

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

The thing attributes.

Definition at line 301 of file DescribeThingResult.h.

◆ AddAttributes() [5/7]

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

The thing attributes.

Definition at line 291 of file DescribeThingResult.h.

◆ AddAttributes() [6/7]

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

The thing attributes.

Definition at line 311 of file DescribeThingResult.h.

◆ AddAttributes() [7/7]

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

The thing attributes.

Definition at line 321 of file DescribeThingResult.h.

◆ GetAttributes()

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

The thing attributes.

Definition at line 266 of file DescribeThingResult.h.

◆ GetBillingGroupName()

const Aws::String& Aws::IoT::Model::DescribeThingResult::GetBillingGroupName ( ) const
inline

The name of the billing group the thing belongs to.

Definition at line 352 of file DescribeThingResult.h.

◆ GetDefaultClientId()

const Aws::String& Aws::IoT::Model::DescribeThingResult::GetDefaultClientId ( ) const
inline

The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.

This lets you better organize your AWS IoT fleet without removing the flexibility of the underlying device certificate model or shadows.

Definition at line 50 of file DescribeThingResult.h.

◆ GetThingArn()

const Aws::String& Aws::IoT::Model::DescribeThingResult::GetThingArn ( ) const
inline

The ARN of the thing to describe.

Definition at line 194 of file DescribeThingResult.h.

◆ GetThingId()

const Aws::String& Aws::IoT::Model::DescribeThingResult::GetThingId ( ) const
inline

The ID of the thing to describe.

Definition at line 158 of file DescribeThingResult.h.

◆ GetThingName()

const Aws::String& Aws::IoT::Model::DescribeThingResult::GetThingName ( ) const
inline

The name of the thing.

Definition at line 122 of file DescribeThingResult.h.

◆ GetThingTypeName()

const Aws::String& Aws::IoT::Model::DescribeThingResult::GetThingTypeName ( ) const
inline

The thing type name.

Definition at line 230 of file DescribeThingResult.h.

◆ GetVersion()

long long Aws::IoT::Model::DescribeThingResult::GetVersion ( ) const
inline

The current version of the thing record in the registry.

To avoid unintentional changes to the information in the registry, you can pass the version information in the expectedVersion parameter of the UpdateThing and DeleteThing calls.

Definition at line 330 of file DescribeThingResult.h.

◆ operator=()

DescribeThingResult& Aws::IoT::Model::DescribeThingResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetAttributes() [1/2]

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

The thing attributes.

Definition at line 276 of file DescribeThingResult.h.

◆ SetAttributes() [2/2]

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

The thing attributes.

Definition at line 271 of file DescribeThingResult.h.

◆ SetBillingGroupName() [1/3]

void Aws::IoT::Model::DescribeThingResult::SetBillingGroupName ( Aws::String &&  value)
inline

The name of the billing group the thing belongs to.

Definition at line 362 of file DescribeThingResult.h.

◆ SetBillingGroupName() [2/3]

void Aws::IoT::Model::DescribeThingResult::SetBillingGroupName ( const Aws::String value)
inline

The name of the billing group the thing belongs to.

Definition at line 357 of file DescribeThingResult.h.

◆ SetBillingGroupName() [3/3]

void Aws::IoT::Model::DescribeThingResult::SetBillingGroupName ( const char *  value)
inline

The name of the billing group the thing belongs to.

Definition at line 367 of file DescribeThingResult.h.

◆ SetDefaultClientId() [1/3]

void Aws::IoT::Model::DescribeThingResult::SetDefaultClientId ( Aws::String &&  value)
inline

The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.

This lets you better organize your AWS IoT fleet without removing the flexibility of the underlying device certificate model or shadows.

Definition at line 72 of file DescribeThingResult.h.

◆ SetDefaultClientId() [2/3]

void Aws::IoT::Model::DescribeThingResult::SetDefaultClientId ( const Aws::String value)
inline

The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.

This lets you better organize your AWS IoT fleet without removing the flexibility of the underlying device certificate model or shadows.

Definition at line 61 of file DescribeThingResult.h.

◆ SetDefaultClientId() [3/3]

void Aws::IoT::Model::DescribeThingResult::SetDefaultClientId ( const char *  value)
inline

The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.

This lets you better organize your AWS IoT fleet without removing the flexibility of the underlying device certificate model or shadows.

Definition at line 83 of file DescribeThingResult.h.

◆ SetThingArn() [1/3]

void Aws::IoT::Model::DescribeThingResult::SetThingArn ( Aws::String &&  value)
inline

The ARN of the thing to describe.

Definition at line 204 of file DescribeThingResult.h.

◆ SetThingArn() [2/3]

void Aws::IoT::Model::DescribeThingResult::SetThingArn ( const Aws::String value)
inline

The ARN of the thing to describe.

Definition at line 199 of file DescribeThingResult.h.

◆ SetThingArn() [3/3]

void Aws::IoT::Model::DescribeThingResult::SetThingArn ( const char *  value)
inline

The ARN of the thing to describe.

Definition at line 209 of file DescribeThingResult.h.

◆ SetThingId() [1/3]

void Aws::IoT::Model::DescribeThingResult::SetThingId ( Aws::String &&  value)
inline

The ID of the thing to describe.

Definition at line 168 of file DescribeThingResult.h.

◆ SetThingId() [2/3]

void Aws::IoT::Model::DescribeThingResult::SetThingId ( const Aws::String value)
inline

The ID of the thing to describe.

Definition at line 163 of file DescribeThingResult.h.

◆ SetThingId() [3/3]

void Aws::IoT::Model::DescribeThingResult::SetThingId ( const char *  value)
inline

The ID of the thing to describe.

Definition at line 173 of file DescribeThingResult.h.

◆ SetThingName() [1/3]

void Aws::IoT::Model::DescribeThingResult::SetThingName ( Aws::String &&  value)
inline

The name of the thing.

Definition at line 132 of file DescribeThingResult.h.

◆ SetThingName() [2/3]

void Aws::IoT::Model::DescribeThingResult::SetThingName ( const Aws::String value)
inline

The name of the thing.

Definition at line 127 of file DescribeThingResult.h.

◆ SetThingName() [3/3]

void Aws::IoT::Model::DescribeThingResult::SetThingName ( const char *  value)
inline

The name of the thing.

Definition at line 137 of file DescribeThingResult.h.

◆ SetThingTypeName() [1/3]

void Aws::IoT::Model::DescribeThingResult::SetThingTypeName ( Aws::String &&  value)
inline

The thing type name.

Definition at line 240 of file DescribeThingResult.h.

◆ SetThingTypeName() [2/3]

void Aws::IoT::Model::DescribeThingResult::SetThingTypeName ( const Aws::String value)
inline

The thing type name.

Definition at line 235 of file DescribeThingResult.h.

◆ SetThingTypeName() [3/3]

void Aws::IoT::Model::DescribeThingResult::SetThingTypeName ( const char *  value)
inline

The thing type name.

Definition at line 245 of file DescribeThingResult.h.

◆ SetVersion()

void Aws::IoT::Model::DescribeThingResult::SetVersion ( long long  value)
inline

The current version of the thing record in the registry.

To avoid unintentional changes to the information in the registry, you can pass the version information in the expectedVersion parameter of the UpdateThing and DeleteThing calls.

Definition at line 338 of file DescribeThingResult.h.

◆ WithAttributes() [1/2]

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

The thing attributes.

Definition at line 286 of file DescribeThingResult.h.

◆ WithAttributes() [2/2]

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

The thing attributes.

Definition at line 281 of file DescribeThingResult.h.

◆ WithBillingGroupName() [1/3]

DescribeThingResult& Aws::IoT::Model::DescribeThingResult::WithBillingGroupName ( Aws::String &&  value)
inline

The name of the billing group the thing belongs to.

Definition at line 377 of file DescribeThingResult.h.

◆ WithBillingGroupName() [2/3]

DescribeThingResult& Aws::IoT::Model::DescribeThingResult::WithBillingGroupName ( const Aws::String value)
inline

The name of the billing group the thing belongs to.

Definition at line 372 of file DescribeThingResult.h.

◆ WithBillingGroupName() [3/3]

DescribeThingResult& Aws::IoT::Model::DescribeThingResult::WithBillingGroupName ( const char *  value)
inline

The name of the billing group the thing belongs to.

Definition at line 382 of file DescribeThingResult.h.

◆ WithDefaultClientId() [1/3]

DescribeThingResult& Aws::IoT::Model::DescribeThingResult::WithDefaultClientId ( Aws::String &&  value)
inline

The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.

This lets you better organize your AWS IoT fleet without removing the flexibility of the underlying device certificate model or shadows.

Definition at line 105 of file DescribeThingResult.h.

◆ WithDefaultClientId() [2/3]

DescribeThingResult& Aws::IoT::Model::DescribeThingResult::WithDefaultClientId ( const Aws::String value)
inline

The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.

This lets you better organize your AWS IoT fleet without removing the flexibility of the underlying device certificate model or shadows.

Definition at line 94 of file DescribeThingResult.h.

◆ WithDefaultClientId() [3/3]

DescribeThingResult& Aws::IoT::Model::DescribeThingResult::WithDefaultClientId ( const char *  value)
inline

The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.

This lets you better organize your AWS IoT fleet without removing the flexibility of the underlying device certificate model or shadows.

Definition at line 116 of file DescribeThingResult.h.

◆ WithThingArn() [1/3]

DescribeThingResult& Aws::IoT::Model::DescribeThingResult::WithThingArn ( Aws::String &&  value)
inline

The ARN of the thing to describe.

Definition at line 219 of file DescribeThingResult.h.

◆ WithThingArn() [2/3]

DescribeThingResult& Aws::IoT::Model::DescribeThingResult::WithThingArn ( const Aws::String value)
inline

The ARN of the thing to describe.

Definition at line 214 of file DescribeThingResult.h.

◆ WithThingArn() [3/3]

DescribeThingResult& Aws::IoT::Model::DescribeThingResult::WithThingArn ( const char *  value)
inline

The ARN of the thing to describe.

Definition at line 224 of file DescribeThingResult.h.

◆ WithThingId() [1/3]

DescribeThingResult& Aws::IoT::Model::DescribeThingResult::WithThingId ( Aws::String &&  value)
inline

The ID of the thing to describe.

Definition at line 183 of file DescribeThingResult.h.

◆ WithThingId() [2/3]

DescribeThingResult& Aws::IoT::Model::DescribeThingResult::WithThingId ( const Aws::String value)
inline

The ID of the thing to describe.

Definition at line 178 of file DescribeThingResult.h.

◆ WithThingId() [3/3]

DescribeThingResult& Aws::IoT::Model::DescribeThingResult::WithThingId ( const char *  value)
inline

The ID of the thing to describe.

Definition at line 188 of file DescribeThingResult.h.

◆ WithThingName() [1/3]

DescribeThingResult& Aws::IoT::Model::DescribeThingResult::WithThingName ( Aws::String &&  value)
inline

The name of the thing.

Definition at line 147 of file DescribeThingResult.h.

◆ WithThingName() [2/3]

DescribeThingResult& Aws::IoT::Model::DescribeThingResult::WithThingName ( const Aws::String value)
inline

The name of the thing.

Definition at line 142 of file DescribeThingResult.h.

◆ WithThingName() [3/3]

DescribeThingResult& Aws::IoT::Model::DescribeThingResult::WithThingName ( const char *  value)
inline

The name of the thing.

Definition at line 152 of file DescribeThingResult.h.

◆ WithThingTypeName() [1/3]

DescribeThingResult& Aws::IoT::Model::DescribeThingResult::WithThingTypeName ( Aws::String &&  value)
inline

The thing type name.

Definition at line 255 of file DescribeThingResult.h.

◆ WithThingTypeName() [2/3]

DescribeThingResult& Aws::IoT::Model::DescribeThingResult::WithThingTypeName ( const Aws::String value)
inline

The thing type name.

Definition at line 250 of file DescribeThingResult.h.

◆ WithThingTypeName() [3/3]

DescribeThingResult& Aws::IoT::Model::DescribeThingResult::WithThingTypeName ( const char *  value)
inline

The thing type name.

Definition at line 260 of file DescribeThingResult.h.

◆ WithVersion()

DescribeThingResult& Aws::IoT::Model::DescribeThingResult::WithVersion ( long long  value)
inline

The current version of the thing record in the registry.

To avoid unintentional changes to the information in the registry, you can pass the version information in the expectedVersion parameter of the UpdateThing and DeleteThing calls.

Definition at line 346 of file DescribeThingResult.h.


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