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/GatewaySummary.h

272 lines
11 KiB
C++

/**
* 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/core/utils/memory/stl/AWSVector.h>
#include <aws/core/utils/DateTime.h>
#include <aws/iotsitewise/model/GatewayCapabilitySummary.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Json
{
class JsonValue;
class JsonView;
} // namespace Json
} // namespace Utils
namespace IoTSiteWise
{
namespace Model
{
/**
* <p>Contains a summary of a gateway.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/GatewaySummary">AWS
* API Reference</a></p>
*/
class AWS_IOTSITEWISE_API GatewaySummary
{
public:
GatewaySummary();
GatewaySummary(Aws::Utils::Json::JsonView jsonValue);
GatewaySummary& operator=(Aws::Utils::Json::JsonView jsonValue);
Aws::Utils::Json::JsonValue Jsonize() const;
/**
* <p>The ID of the gateway device.</p>
*/
inline const Aws::String& GetGatewayId() const{ return m_gatewayId; }
/**
* <p>The ID of the gateway device.</p>
*/
inline bool GatewayIdHasBeenSet() const { return m_gatewayIdHasBeenSet; }
/**
* <p>The ID of the gateway device.</p>
*/
inline void SetGatewayId(const Aws::String& value) { m_gatewayIdHasBeenSet = true; m_gatewayId = value; }
/**
* <p>The ID of the gateway device.</p>
*/
inline void SetGatewayId(Aws::String&& value) { m_gatewayIdHasBeenSet = true; m_gatewayId = std::move(value); }
/**
* <p>The ID of the gateway device.</p>
*/
inline void SetGatewayId(const char* value) { m_gatewayIdHasBeenSet = true; m_gatewayId.assign(value); }
/**
* <p>The ID of the gateway device.</p>
*/
inline GatewaySummary& WithGatewayId(const Aws::String& value) { SetGatewayId(value); return *this;}
/**
* <p>The ID of the gateway device.</p>
*/
inline GatewaySummary& WithGatewayId(Aws::String&& value) { SetGatewayId(std::move(value)); return *this;}
/**
* <p>The ID of the gateway device.</p>
*/
inline GatewaySummary& WithGatewayId(const char* value) { SetGatewayId(value); return *this;}
/**
* <p>The name of the asset.</p>
*/
inline const Aws::String& GetGatewayName() const{ return m_gatewayName; }
/**
* <p>The name of the asset.</p>
*/
inline bool GatewayNameHasBeenSet() const { return m_gatewayNameHasBeenSet; }
/**
* <p>The name of the asset.</p>
*/
inline void SetGatewayName(const Aws::String& value) { m_gatewayNameHasBeenSet = true; m_gatewayName = value; }
/**
* <p>The name of the asset.</p>
*/
inline void SetGatewayName(Aws::String&& value) { m_gatewayNameHasBeenSet = true; m_gatewayName = std::move(value); }
/**
* <p>The name of the asset.</p>
*/
inline void SetGatewayName(const char* value) { m_gatewayNameHasBeenSet = true; m_gatewayName.assign(value); }
/**
* <p>The name of the asset.</p>
*/
inline GatewaySummary& WithGatewayName(const Aws::String& value) { SetGatewayName(value); return *this;}
/**
* <p>The name of the asset.</p>
*/
inline GatewaySummary& WithGatewayName(Aws::String&& value) { SetGatewayName(std::move(value)); return *this;}
/**
* <p>The name of the asset.</p>
*/
inline GatewaySummary& WithGatewayName(const char* value) { SetGatewayName(value); return *this;}
/**
* <p>A list of gateway capability summaries that each contain a namespace and
* status. Each gateway capability defines data sources for the gateway. To
* retrieve a capability configuration's definition, use <a
* href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html">DescribeGatewayCapabilityConfiguration</a>.</p>
*/
inline const Aws::Vector<GatewayCapabilitySummary>& GetGatewayCapabilitySummaries() const{ return m_gatewayCapabilitySummaries; }
/**
* <p>A list of gateway capability summaries that each contain a namespace and
* status. Each gateway capability defines data sources for the gateway. To
* retrieve a capability configuration's definition, use <a
* href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html">DescribeGatewayCapabilityConfiguration</a>.</p>
*/
inline bool GatewayCapabilitySummariesHasBeenSet() const { return m_gatewayCapabilitySummariesHasBeenSet; }
/**
* <p>A list of gateway capability summaries that each contain a namespace and
* status. Each gateway capability defines data sources for the gateway. To
* retrieve a capability configuration's definition, use <a
* href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html">DescribeGatewayCapabilityConfiguration</a>.</p>
*/
inline void SetGatewayCapabilitySummaries(const Aws::Vector<GatewayCapabilitySummary>& value) { m_gatewayCapabilitySummariesHasBeenSet = true; m_gatewayCapabilitySummaries = value; }
/**
* <p>A list of gateway capability summaries that each contain a namespace and
* status. Each gateway capability defines data sources for the gateway. To
* retrieve a capability configuration's definition, use <a
* href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html">DescribeGatewayCapabilityConfiguration</a>.</p>
*/
inline void SetGatewayCapabilitySummaries(Aws::Vector<GatewayCapabilitySummary>&& value) { m_gatewayCapabilitySummariesHasBeenSet = true; m_gatewayCapabilitySummaries = std::move(value); }
/**
* <p>A list of gateway capability summaries that each contain a namespace and
* status. Each gateway capability defines data sources for the gateway. To
* retrieve a capability configuration's definition, use <a
* href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html">DescribeGatewayCapabilityConfiguration</a>.</p>
*/
inline GatewaySummary& WithGatewayCapabilitySummaries(const Aws::Vector<GatewayCapabilitySummary>& value) { SetGatewayCapabilitySummaries(value); return *this;}
/**
* <p>A list of gateway capability summaries that each contain a namespace and
* status. Each gateway capability defines data sources for the gateway. To
* retrieve a capability configuration's definition, use <a
* href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html">DescribeGatewayCapabilityConfiguration</a>.</p>
*/
inline GatewaySummary& WithGatewayCapabilitySummaries(Aws::Vector<GatewayCapabilitySummary>&& value) { SetGatewayCapabilitySummaries(std::move(value)); return *this;}
/**
* <p>A list of gateway capability summaries that each contain a namespace and
* status. Each gateway capability defines data sources for the gateway. To
* retrieve a capability configuration's definition, use <a
* href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html">DescribeGatewayCapabilityConfiguration</a>.</p>
*/
inline GatewaySummary& AddGatewayCapabilitySummaries(const GatewayCapabilitySummary& value) { m_gatewayCapabilitySummariesHasBeenSet = true; m_gatewayCapabilitySummaries.push_back(value); return *this; }
/**
* <p>A list of gateway capability summaries that each contain a namespace and
* status. Each gateway capability defines data sources for the gateway. To
* retrieve a capability configuration's definition, use <a
* href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html">DescribeGatewayCapabilityConfiguration</a>.</p>
*/
inline GatewaySummary& AddGatewayCapabilitySummaries(GatewayCapabilitySummary&& value) { m_gatewayCapabilitySummariesHasBeenSet = true; m_gatewayCapabilitySummaries.push_back(std::move(value)); return *this; }
/**
* <p>The date the gateway was created, in Unix epoch time.</p>
*/
inline const Aws::Utils::DateTime& GetCreationDate() const{ return m_creationDate; }
/**
* <p>The date the gateway was created, in Unix epoch time.</p>
*/
inline bool CreationDateHasBeenSet() const { return m_creationDateHasBeenSet; }
/**
* <p>The date the gateway was created, in Unix epoch time.</p>
*/
inline void SetCreationDate(const Aws::Utils::DateTime& value) { m_creationDateHasBeenSet = true; m_creationDate = value; }
/**
* <p>The date the gateway was created, in Unix epoch time.</p>
*/
inline void SetCreationDate(Aws::Utils::DateTime&& value) { m_creationDateHasBeenSet = true; m_creationDate = std::move(value); }
/**
* <p>The date the gateway was created, in Unix epoch time.</p>
*/
inline GatewaySummary& WithCreationDate(const Aws::Utils::DateTime& value) { SetCreationDate(value); return *this;}
/**
* <p>The date the gateway was created, in Unix epoch time.</p>
*/
inline GatewaySummary& WithCreationDate(Aws::Utils::DateTime&& value) { SetCreationDate(std::move(value)); return *this;}
/**
* <p>The date the gateway was last updated, in Unix epoch time.</p>
*/
inline const Aws::Utils::DateTime& GetLastUpdateDate() const{ return m_lastUpdateDate; }
/**
* <p>The date the gateway was last updated, in Unix epoch time.</p>
*/
inline bool LastUpdateDateHasBeenSet() const { return m_lastUpdateDateHasBeenSet; }
/**
* <p>The date the gateway was last updated, in Unix epoch time.</p>
*/
inline void SetLastUpdateDate(const Aws::Utils::DateTime& value) { m_lastUpdateDateHasBeenSet = true; m_lastUpdateDate = value; }
/**
* <p>The date the gateway was last updated, in Unix epoch time.</p>
*/
inline void SetLastUpdateDate(Aws::Utils::DateTime&& value) { m_lastUpdateDateHasBeenSet = true; m_lastUpdateDate = std::move(value); }
/**
* <p>The date the gateway was last updated, in Unix epoch time.</p>
*/
inline GatewaySummary& WithLastUpdateDate(const Aws::Utils::DateTime& value) { SetLastUpdateDate(value); return *this;}
/**
* <p>The date the gateway was last updated, in Unix epoch time.</p>
*/
inline GatewaySummary& WithLastUpdateDate(Aws::Utils::DateTime&& value) { SetLastUpdateDate(std::move(value)); return *this;}
private:
Aws::String m_gatewayId;
bool m_gatewayIdHasBeenSet;
Aws::String m_gatewayName;
bool m_gatewayNameHasBeenSet;
Aws::Vector<GatewayCapabilitySummary> m_gatewayCapabilitySummaries;
bool m_gatewayCapabilitySummariesHasBeenSet;
Aws::Utils::DateTime m_creationDate;
bool m_creationDateHasBeenSet;
Aws::Utils::DateTime m_lastUpdateDate;
bool m_lastUpdateDateHasBeenSet;
};
} // namespace Model
} // namespace IoTSiteWise
} // namespace Aws