This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-iotsitewise/include/aws/iotsitewise/model/DescribeGatewayCapabilityConfigurationResult.h

229 lines
10 KiB
C
Raw Normal View History

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/iotsitewise/IoTSiteWise_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/iotsitewise/model/CapabilitySyncStatus.h>
#include <utility>
namespace Aws
{
template<typename RESULT_TYPE>
class AmazonWebServiceResult;
namespace Utils
{
namespace Json
{
class JsonValue;
} // namespace Json
} // namespace Utils
namespace IoTSiteWise
{
namespace Model
{
class AWS_IOTSITEWISE_API DescribeGatewayCapabilityConfigurationResult
{
public:
DescribeGatewayCapabilityConfigurationResult();
DescribeGatewayCapabilityConfigurationResult(const Aws::AmazonWebServiceResult<Aws::Utils::Json::JsonValue>& result);
DescribeGatewayCapabilityConfigurationResult& operator=(const Aws::AmazonWebServiceResult<Aws::Utils::Json::JsonValue>& result);
/**
* <p>The ID of the gateway that defines the capability configuration.</p>
*/
inline const Aws::String& GetGatewayId() const{ return m_gatewayId; }
/**
* <p>The ID of the gateway that defines the capability configuration.</p>
*/
inline void SetGatewayId(const Aws::String& value) { m_gatewayId = value; }
/**
* <p>The ID of the gateway that defines the capability configuration.</p>
*/
inline void SetGatewayId(Aws::String&& value) { m_gatewayId = std::move(value); }
/**
* <p>The ID of the gateway that defines the capability configuration.</p>
*/
inline void SetGatewayId(const char* value) { m_gatewayId.assign(value); }
/**
* <p>The ID of the gateway that defines the capability configuration.</p>
*/
inline DescribeGatewayCapabilityConfigurationResult& WithGatewayId(const Aws::String& value) { SetGatewayId(value); return *this;}
/**
* <p>The ID of the gateway that defines the capability configuration.</p>
*/
inline DescribeGatewayCapabilityConfigurationResult& WithGatewayId(Aws::String&& value) { SetGatewayId(std::move(value)); return *this;}
/**
* <p>The ID of the gateway that defines the capability configuration.</p>
*/
inline DescribeGatewayCapabilityConfigurationResult& WithGatewayId(const char* value) { SetGatewayId(value); return *this;}
/**
* <p>The namespace of the gateway capability.</p>
*/
inline const Aws::String& GetCapabilityNamespace() const{ return m_capabilityNamespace; }
/**
* <p>The namespace of the gateway capability.</p>
*/
inline void SetCapabilityNamespace(const Aws::String& value) { m_capabilityNamespace = value; }
/**
* <p>The namespace of the gateway capability.</p>
*/
inline void SetCapabilityNamespace(Aws::String&& value) { m_capabilityNamespace = std::move(value); }
/**
* <p>The namespace of the gateway capability.</p>
*/
inline void SetCapabilityNamespace(const char* value) { m_capabilityNamespace.assign(value); }
/**
* <p>The namespace of the gateway capability.</p>
*/
inline DescribeGatewayCapabilityConfigurationResult& WithCapabilityNamespace(const Aws::String& value) { SetCapabilityNamespace(value); return *this;}
/**
* <p>The namespace of the gateway capability.</p>
*/
inline DescribeGatewayCapabilityConfigurationResult& WithCapabilityNamespace(Aws::String&& value) { SetCapabilityNamespace(std::move(value)); return *this;}
/**
* <p>The namespace of the gateway capability.</p>
*/
inline DescribeGatewayCapabilityConfigurationResult& WithCapabilityNamespace(const char* value) { SetCapabilityNamespace(value); return *this;}
/**
* <p>The JSON document that defines the gateway capability's configuration. For
* more information, see <a
* href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli">Configuring
* data sources (CLI)</a> in the <i>AWS IoT SiteWise User Guide</i>.</p>
*/
inline const Aws::String& GetCapabilityConfiguration() const{ return m_capabilityConfiguration; }
/**
* <p>The JSON document that defines the gateway capability's configuration. For
* more information, see <a
* href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli">Configuring
* data sources (CLI)</a> in the <i>AWS IoT SiteWise User Guide</i>.</p>
*/
inline void SetCapabilityConfiguration(const Aws::String& value) { m_capabilityConfiguration = value; }
/**
* <p>The JSON document that defines the gateway capability's configuration. For
* more information, see <a
* href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli">Configuring
* data sources (CLI)</a> in the <i>AWS IoT SiteWise User Guide</i>.</p>
*/
inline void SetCapabilityConfiguration(Aws::String&& value) { m_capabilityConfiguration = std::move(value); }
/**
* <p>The JSON document that defines the gateway capability's configuration. For
* more information, see <a
* href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli">Configuring
* data sources (CLI)</a> in the <i>AWS IoT SiteWise User Guide</i>.</p>
*/
inline void SetCapabilityConfiguration(const char* value) { m_capabilityConfiguration.assign(value); }
/**
* <p>The JSON document that defines the gateway capability's configuration. For
* more information, see <a
* href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli">Configuring
* data sources (CLI)</a> in the <i>AWS IoT SiteWise User Guide</i>.</p>
*/
inline DescribeGatewayCapabilityConfigurationResult& WithCapabilityConfiguration(const Aws::String& value) { SetCapabilityConfiguration(value); return *this;}
/**
* <p>The JSON document that defines the gateway capability's configuration. For
* more information, see <a
* href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli">Configuring
* data sources (CLI)</a> in the <i>AWS IoT SiteWise User Guide</i>.</p>
*/
inline DescribeGatewayCapabilityConfigurationResult& WithCapabilityConfiguration(Aws::String&& value) { SetCapabilityConfiguration(std::move(value)); return *this;}
/**
* <p>The JSON document that defines the gateway capability's configuration. For
* more information, see <a
* href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli">Configuring
* data sources (CLI)</a> in the <i>AWS IoT SiteWise User Guide</i>.</p>
*/
inline DescribeGatewayCapabilityConfigurationResult& WithCapabilityConfiguration(const char* value) { SetCapabilityConfiguration(value); return *this;}
/**
* <p>The synchronization status of the capability configuration. The sync status
* can be one of the following:</p> <ul> <li> <p> <code>IN_SYNC</code> The
* gateway is running the capability configuration.</p> </li> <li> <p>
* <code>OUT_OF_SYNC</code> The gateway hasn't received the capability
* configuration.</p> </li> <li> <p> <code>SYNC_FAILED</code> The gateway
* rejected the capability configuration.</p> </li> </ul>
*/
inline const CapabilitySyncStatus& GetCapabilitySyncStatus() const{ return m_capabilitySyncStatus; }
/**
* <p>The synchronization status of the capability configuration. The sync status
* can be one of the following:</p> <ul> <li> <p> <code>IN_SYNC</code> The
* gateway is running the capability configuration.</p> </li> <li> <p>
* <code>OUT_OF_SYNC</code> The gateway hasn't received the capability
* configuration.</p> </li> <li> <p> <code>SYNC_FAILED</code> The gateway
* rejected the capability configuration.</p> </li> </ul>
*/
inline void SetCapabilitySyncStatus(const CapabilitySyncStatus& value) { m_capabilitySyncStatus = value; }
/**
* <p>The synchronization status of the capability configuration. The sync status
* can be one of the following:</p> <ul> <li> <p> <code>IN_SYNC</code> The
* gateway is running the capability configuration.</p> </li> <li> <p>
* <code>OUT_OF_SYNC</code> The gateway hasn't received the capability
* configuration.</p> </li> <li> <p> <code>SYNC_FAILED</code> The gateway
* rejected the capability configuration.</p> </li> </ul>
*/
inline void SetCapabilitySyncStatus(CapabilitySyncStatus&& value) { m_capabilitySyncStatus = std::move(value); }
/**
* <p>The synchronization status of the capability configuration. The sync status
* can be one of the following:</p> <ul> <li> <p> <code>IN_SYNC</code> The
* gateway is running the capability configuration.</p> </li> <li> <p>
* <code>OUT_OF_SYNC</code> The gateway hasn't received the capability
* configuration.</p> </li> <li> <p> <code>SYNC_FAILED</code> The gateway
* rejected the capability configuration.</p> </li> </ul>
*/
inline DescribeGatewayCapabilityConfigurationResult& WithCapabilitySyncStatus(const CapabilitySyncStatus& value) { SetCapabilitySyncStatus(value); return *this;}
/**
* <p>The synchronization status of the capability configuration. The sync status
* can be one of the following:</p> <ul> <li> <p> <code>IN_SYNC</code> The
* gateway is running the capability configuration.</p> </li> <li> <p>
* <code>OUT_OF_SYNC</code> The gateway hasn't received the capability
* configuration.</p> </li> <li> <p> <code>SYNC_FAILED</code> The gateway
* rejected the capability configuration.</p> </li> </ul>
*/
inline DescribeGatewayCapabilityConfigurationResult& WithCapabilitySyncStatus(CapabilitySyncStatus&& value) { SetCapabilitySyncStatus(std::move(value)); return *this;}
private:
Aws::String m_gatewayId;
Aws::String m_capabilityNamespace;
Aws::String m_capabilityConfiguration;
CapabilitySyncStatus m_capabilitySyncStatus;
};
} // namespace Model
} // namespace IoTSiteWise
} // namespace Aws