/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { template class AmazonWebServiceResult; namespace Utils { namespace Json { class JsonValue; } // namespace Json } // namespace Utils namespace IoT { namespace Model { /** *

The output from the DescribeThing operation.

See Also:

AWS * API Reference

*/ class DescribeThingResult { public: AWS_IOT_API DescribeThingResult(); AWS_IOT_API DescribeThingResult(const Aws::AmazonWebServiceResult& result); AWS_IOT_API DescribeThingResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

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 IoT fleet without removing the flexibility of the underlying * device certificate model or shadows.

*/ inline const Aws::String& GetDefaultClientId() const{ return m_defaultClientId; } /** *

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 IoT fleet without removing the flexibility of the underlying * device certificate model or shadows.

*/ inline void SetDefaultClientId(const Aws::String& value) { m_defaultClientId = value; } /** *

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 IoT fleet without removing the flexibility of the underlying * device certificate model or shadows.

*/ inline void SetDefaultClientId(Aws::String&& value) { m_defaultClientId = std::move(value); } /** *

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 IoT fleet without removing the flexibility of the underlying * device certificate model or shadows.

*/ inline void SetDefaultClientId(const char* value) { m_defaultClientId.assign(value); } /** *

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 IoT fleet without removing the flexibility of the underlying * device certificate model or shadows.

*/ inline DescribeThingResult& WithDefaultClientId(const Aws::String& value) { SetDefaultClientId(value); return *this;} /** *

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 IoT fleet without removing the flexibility of the underlying * device certificate model or shadows.

*/ inline DescribeThingResult& WithDefaultClientId(Aws::String&& value) { SetDefaultClientId(std::move(value)); return *this;} /** *

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 IoT fleet without removing the flexibility of the underlying * device certificate model or shadows.

*/ inline DescribeThingResult& WithDefaultClientId(const char* value) { SetDefaultClientId(value); return *this;} /** *

The name of the thing.

*/ inline const Aws::String& GetThingName() const{ return m_thingName; } /** *

The name of the thing.

*/ inline void SetThingName(const Aws::String& value) { m_thingName = value; } /** *

The name of the thing.

*/ inline void SetThingName(Aws::String&& value) { m_thingName = std::move(value); } /** *

The name of the thing.

*/ inline void SetThingName(const char* value) { m_thingName.assign(value); } /** *

The name of the thing.

*/ inline DescribeThingResult& WithThingName(const Aws::String& value) { SetThingName(value); return *this;} /** *

The name of the thing.

*/ inline DescribeThingResult& WithThingName(Aws::String&& value) { SetThingName(std::move(value)); return *this;} /** *

The name of the thing.

*/ inline DescribeThingResult& WithThingName(const char* value) { SetThingName(value); return *this;} /** *

The ID of the thing to describe.

*/ inline const Aws::String& GetThingId() const{ return m_thingId; } /** *

The ID of the thing to describe.

*/ inline void SetThingId(const Aws::String& value) { m_thingId = value; } /** *

The ID of the thing to describe.

*/ inline void SetThingId(Aws::String&& value) { m_thingId = std::move(value); } /** *

The ID of the thing to describe.

*/ inline void SetThingId(const char* value) { m_thingId.assign(value); } /** *

The ID of the thing to describe.

*/ inline DescribeThingResult& WithThingId(const Aws::String& value) { SetThingId(value); return *this;} /** *

The ID of the thing to describe.

*/ inline DescribeThingResult& WithThingId(Aws::String&& value) { SetThingId(std::move(value)); return *this;} /** *

The ID of the thing to describe.

*/ inline DescribeThingResult& WithThingId(const char* value) { SetThingId(value); return *this;} /** *

The ARN of the thing to describe.

*/ inline const Aws::String& GetThingArn() const{ return m_thingArn; } /** *

The ARN of the thing to describe.

*/ inline void SetThingArn(const Aws::String& value) { m_thingArn = value; } /** *

The ARN of the thing to describe.

*/ inline void SetThingArn(Aws::String&& value) { m_thingArn = std::move(value); } /** *

The ARN of the thing to describe.

*/ inline void SetThingArn(const char* value) { m_thingArn.assign(value); } /** *

The ARN of the thing to describe.

*/ inline DescribeThingResult& WithThingArn(const Aws::String& value) { SetThingArn(value); return *this;} /** *

The ARN of the thing to describe.

*/ inline DescribeThingResult& WithThingArn(Aws::String&& value) { SetThingArn(std::move(value)); return *this;} /** *

The ARN of the thing to describe.

*/ inline DescribeThingResult& WithThingArn(const char* value) { SetThingArn(value); return *this;} /** *

The thing type name.

*/ inline const Aws::String& GetThingTypeName() const{ return m_thingTypeName; } /** *

The thing type name.

*/ inline void SetThingTypeName(const Aws::String& value) { m_thingTypeName = value; } /** *

The thing type name.

*/ inline void SetThingTypeName(Aws::String&& value) { m_thingTypeName = std::move(value); } /** *

The thing type name.

*/ inline void SetThingTypeName(const char* value) { m_thingTypeName.assign(value); } /** *

The thing type name.

*/ inline DescribeThingResult& WithThingTypeName(const Aws::String& value) { SetThingTypeName(value); return *this;} /** *

The thing type name.

*/ inline DescribeThingResult& WithThingTypeName(Aws::String&& value) { SetThingTypeName(std::move(value)); return *this;} /** *

The thing type name.

*/ inline DescribeThingResult& WithThingTypeName(const char* value) { SetThingTypeName(value); return *this;} /** *

The thing attributes.

*/ inline const Aws::Map& GetAttributes() const{ return m_attributes; } /** *

The thing attributes.

*/ inline void SetAttributes(const Aws::Map& value) { m_attributes = value; } /** *

The thing attributes.

*/ inline void SetAttributes(Aws::Map&& value) { m_attributes = std::move(value); } /** *

The thing attributes.

*/ inline DescribeThingResult& WithAttributes(const Aws::Map& value) { SetAttributes(value); return *this;} /** *

The thing attributes.

*/ inline DescribeThingResult& WithAttributes(Aws::Map&& value) { SetAttributes(std::move(value)); return *this;} /** *

The thing attributes.

*/ inline DescribeThingResult& AddAttributes(const Aws::String& key, const Aws::String& value) { m_attributes.emplace(key, value); return *this; } /** *

The thing attributes.

*/ inline DescribeThingResult& AddAttributes(Aws::String&& key, const Aws::String& value) { m_attributes.emplace(std::move(key), value); return *this; } /** *

The thing attributes.

*/ inline DescribeThingResult& AddAttributes(const Aws::String& key, Aws::String&& value) { m_attributes.emplace(key, std::move(value)); return *this; } /** *

The thing attributes.

*/ inline DescribeThingResult& AddAttributes(Aws::String&& key, Aws::String&& value) { m_attributes.emplace(std::move(key), std::move(value)); return *this; } /** *

The thing attributes.

*/ inline DescribeThingResult& AddAttributes(const char* key, Aws::String&& value) { m_attributes.emplace(key, std::move(value)); return *this; } /** *

The thing attributes.

*/ inline DescribeThingResult& AddAttributes(Aws::String&& key, const char* value) { m_attributes.emplace(std::move(key), value); return *this; } /** *

The thing attributes.

*/ inline DescribeThingResult& AddAttributes(const char* key, const char* value) { m_attributes.emplace(key, value); return *this; } /** *

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.

*/ inline long long GetVersion() const{ return m_version; } /** *

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.

*/ inline void SetVersion(long long value) { m_version = value; } /** *

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.

*/ inline DescribeThingResult& WithVersion(long long value) { SetVersion(value); return *this;} /** *

The name of the billing group the thing belongs to.

*/ inline const Aws::String& GetBillingGroupName() const{ return m_billingGroupName; } /** *

The name of the billing group the thing belongs to.

*/ inline void SetBillingGroupName(const Aws::String& value) { m_billingGroupName = value; } /** *

The name of the billing group the thing belongs to.

*/ inline void SetBillingGroupName(Aws::String&& value) { m_billingGroupName = std::move(value); } /** *

The name of the billing group the thing belongs to.

*/ inline void SetBillingGroupName(const char* value) { m_billingGroupName.assign(value); } /** *

The name of the billing group the thing belongs to.

*/ inline DescribeThingResult& WithBillingGroupName(const Aws::String& value) { SetBillingGroupName(value); return *this;} /** *

The name of the billing group the thing belongs to.

*/ inline DescribeThingResult& WithBillingGroupName(Aws::String&& value) { SetBillingGroupName(std::move(value)); return *this;} /** *

The name of the billing group the thing belongs to.

*/ inline DescribeThingResult& WithBillingGroupName(const char* value) { SetBillingGroupName(value); return *this;} inline const Aws::String& GetRequestId() const{ return m_requestId; } inline void SetRequestId(const Aws::String& value) { m_requestId = value; } inline void SetRequestId(Aws::String&& value) { m_requestId = std::move(value); } inline void SetRequestId(const char* value) { m_requestId.assign(value); } inline DescribeThingResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline DescribeThingResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline DescribeThingResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} private: Aws::String m_defaultClientId; Aws::String m_thingName; Aws::String m_thingId; Aws::String m_thingArn; Aws::String m_thingTypeName; Aws::Map m_attributes; long long m_version; Aws::String m_billingGroupName; Aws::String m_requestId; }; } // namespace Model } // namespace IoT } // namespace Aws