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

A collection of data from an MQTT topic. Channels archive the raw, * unprocessed messages before publishing the data to a pipeline.

See * Also:

AWS * API Reference

*/ class Channel { public: AWS_IOTANALYTICS_API Channel(); AWS_IOTANALYTICS_API Channel(Aws::Utils::Json::JsonView jsonValue); AWS_IOTANALYTICS_API Channel& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_IOTANALYTICS_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The name of the channel.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

The name of the channel.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The name of the channel.

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

The name of the channel.

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

The name of the channel.

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

The name of the channel.

*/ inline Channel& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

The name of the channel.

*/ inline Channel& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

The name of the channel.

*/ inline Channel& WithName(const char* value) { SetName(value); return *this;} /** *

Where channel data is stored. You can choose one of * serviceManagedS3 or customerManagedS3 storage. If not * specified, the default is serviceManagedS3. You can't change this * storage option after the channel is created.

*/ inline const ChannelStorage& GetStorage() const{ return m_storage; } /** *

Where channel data is stored. You can choose one of * serviceManagedS3 or customerManagedS3 storage. If not * specified, the default is serviceManagedS3. You can't change this * storage option after the channel is created.

*/ inline bool StorageHasBeenSet() const { return m_storageHasBeenSet; } /** *

Where channel data is stored. You can choose one of * serviceManagedS3 or customerManagedS3 storage. If not * specified, the default is serviceManagedS3. You can't change this * storage option after the channel is created.

*/ inline void SetStorage(const ChannelStorage& value) { m_storageHasBeenSet = true; m_storage = value; } /** *

Where channel data is stored. You can choose one of * serviceManagedS3 or customerManagedS3 storage. If not * specified, the default is serviceManagedS3. You can't change this * storage option after the channel is created.

*/ inline void SetStorage(ChannelStorage&& value) { m_storageHasBeenSet = true; m_storage = std::move(value); } /** *

Where channel data is stored. You can choose one of * serviceManagedS3 or customerManagedS3 storage. If not * specified, the default is serviceManagedS3. You can't change this * storage option after the channel is created.

*/ inline Channel& WithStorage(const ChannelStorage& value) { SetStorage(value); return *this;} /** *

Where channel data is stored. You can choose one of * serviceManagedS3 or customerManagedS3 storage. If not * specified, the default is serviceManagedS3. You can't change this * storage option after the channel is created.

*/ inline Channel& WithStorage(ChannelStorage&& value) { SetStorage(std::move(value)); return *this;} /** *

The ARN of the channel.

*/ inline const Aws::String& GetArn() const{ return m_arn; } /** *

The ARN of the channel.

*/ inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } /** *

The ARN of the channel.

*/ inline void SetArn(const Aws::String& value) { m_arnHasBeenSet = true; m_arn = value; } /** *

The ARN of the channel.

*/ inline void SetArn(Aws::String&& value) { m_arnHasBeenSet = true; m_arn = std::move(value); } /** *

The ARN of the channel.

*/ inline void SetArn(const char* value) { m_arnHasBeenSet = true; m_arn.assign(value); } /** *

The ARN of the channel.

*/ inline Channel& WithArn(const Aws::String& value) { SetArn(value); return *this;} /** *

The ARN of the channel.

*/ inline Channel& WithArn(Aws::String&& value) { SetArn(std::move(value)); return *this;} /** *

The ARN of the channel.

*/ inline Channel& WithArn(const char* value) { SetArn(value); return *this;} /** *

The status of the channel.

*/ inline const ChannelStatus& GetStatus() const{ return m_status; } /** *

The status of the channel.

*/ inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } /** *

The status of the channel.

*/ inline void SetStatus(const ChannelStatus& value) { m_statusHasBeenSet = true; m_status = value; } /** *

The status of the channel.

*/ inline void SetStatus(ChannelStatus&& value) { m_statusHasBeenSet = true; m_status = std::move(value); } /** *

The status of the channel.

*/ inline Channel& WithStatus(const ChannelStatus& value) { SetStatus(value); return *this;} /** *

The status of the channel.

*/ inline Channel& WithStatus(ChannelStatus&& value) { SetStatus(std::move(value)); return *this;} /** *

How long, in days, message data is kept for the channel.

*/ inline const RetentionPeriod& GetRetentionPeriod() const{ return m_retentionPeriod; } /** *

How long, in days, message data is kept for the channel.

*/ inline bool RetentionPeriodHasBeenSet() const { return m_retentionPeriodHasBeenSet; } /** *

How long, in days, message data is kept for the channel.

*/ inline void SetRetentionPeriod(const RetentionPeriod& value) { m_retentionPeriodHasBeenSet = true; m_retentionPeriod = value; } /** *

How long, in days, message data is kept for the channel.

*/ inline void SetRetentionPeriod(RetentionPeriod&& value) { m_retentionPeriodHasBeenSet = true; m_retentionPeriod = std::move(value); } /** *

How long, in days, message data is kept for the channel.

*/ inline Channel& WithRetentionPeriod(const RetentionPeriod& value) { SetRetentionPeriod(value); return *this;} /** *

How long, in days, message data is kept for the channel.

*/ inline Channel& WithRetentionPeriod(RetentionPeriod&& value) { SetRetentionPeriod(std::move(value)); return *this;} /** *

When the channel was created.

*/ inline const Aws::Utils::DateTime& GetCreationTime() const{ return m_creationTime; } /** *

When the channel was created.

*/ inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; } /** *

When the channel was created.

*/ inline void SetCreationTime(const Aws::Utils::DateTime& value) { m_creationTimeHasBeenSet = true; m_creationTime = value; } /** *

When the channel was created.

*/ inline void SetCreationTime(Aws::Utils::DateTime&& value) { m_creationTimeHasBeenSet = true; m_creationTime = std::move(value); } /** *

When the channel was created.

*/ inline Channel& WithCreationTime(const Aws::Utils::DateTime& value) { SetCreationTime(value); return *this;} /** *

When the channel was created.

*/ inline Channel& WithCreationTime(Aws::Utils::DateTime&& value) { SetCreationTime(std::move(value)); return *this;} /** *

When the channel was last updated.

*/ inline const Aws::Utils::DateTime& GetLastUpdateTime() const{ return m_lastUpdateTime; } /** *

When the channel was last updated.

*/ inline bool LastUpdateTimeHasBeenSet() const { return m_lastUpdateTimeHasBeenSet; } /** *

When the channel was last updated.

*/ inline void SetLastUpdateTime(const Aws::Utils::DateTime& value) { m_lastUpdateTimeHasBeenSet = true; m_lastUpdateTime = value; } /** *

When the channel was last updated.

*/ inline void SetLastUpdateTime(Aws::Utils::DateTime&& value) { m_lastUpdateTimeHasBeenSet = true; m_lastUpdateTime = std::move(value); } /** *

When the channel was last updated.

*/ inline Channel& WithLastUpdateTime(const Aws::Utils::DateTime& value) { SetLastUpdateTime(value); return *this;} /** *

When the channel was last updated.

*/ inline Channel& WithLastUpdateTime(Aws::Utils::DateTime&& value) { SetLastUpdateTime(std::move(value)); return *this;} /** *

The last time when a new message arrived in the channel.

IoT Analytics * updates this value at most once per minute for one channel. Hence, the * lastMessageArrivalTime value is an approximation.

This * feature only applies to messages that arrived in the data store after October * 23, 2020.

*/ inline const Aws::Utils::DateTime& GetLastMessageArrivalTime() const{ return m_lastMessageArrivalTime; } /** *

The last time when a new message arrived in the channel.

IoT Analytics * updates this value at most once per minute for one channel. Hence, the * lastMessageArrivalTime value is an approximation.

This * feature only applies to messages that arrived in the data store after October * 23, 2020.

*/ inline bool LastMessageArrivalTimeHasBeenSet() const { return m_lastMessageArrivalTimeHasBeenSet; } /** *

The last time when a new message arrived in the channel.

IoT Analytics * updates this value at most once per minute for one channel. Hence, the * lastMessageArrivalTime value is an approximation.

This * feature only applies to messages that arrived in the data store after October * 23, 2020.

*/ inline void SetLastMessageArrivalTime(const Aws::Utils::DateTime& value) { m_lastMessageArrivalTimeHasBeenSet = true; m_lastMessageArrivalTime = value; } /** *

The last time when a new message arrived in the channel.

IoT Analytics * updates this value at most once per minute for one channel. Hence, the * lastMessageArrivalTime value is an approximation.

This * feature only applies to messages that arrived in the data store after October * 23, 2020.

*/ inline void SetLastMessageArrivalTime(Aws::Utils::DateTime&& value) { m_lastMessageArrivalTimeHasBeenSet = true; m_lastMessageArrivalTime = std::move(value); } /** *

The last time when a new message arrived in the channel.

IoT Analytics * updates this value at most once per minute for one channel. Hence, the * lastMessageArrivalTime value is an approximation.

This * feature only applies to messages that arrived in the data store after October * 23, 2020.

*/ inline Channel& WithLastMessageArrivalTime(const Aws::Utils::DateTime& value) { SetLastMessageArrivalTime(value); return *this;} /** *

The last time when a new message arrived in the channel.

IoT Analytics * updates this value at most once per minute for one channel. Hence, the * lastMessageArrivalTime value is an approximation.

This * feature only applies to messages that arrived in the data store after October * 23, 2020.

*/ inline Channel& WithLastMessageArrivalTime(Aws::Utils::DateTime&& value) { SetLastMessageArrivalTime(std::move(value)); return *this;} private: Aws::String m_name; bool m_nameHasBeenSet = false; ChannelStorage m_storage; bool m_storageHasBeenSet = false; Aws::String m_arn; bool m_arnHasBeenSet = false; ChannelStatus m_status; bool m_statusHasBeenSet = false; RetentionPeriod m_retentionPeriod; bool m_retentionPeriodHasBeenSet = false; Aws::Utils::DateTime m_creationTime; bool m_creationTimeHasBeenSet = false; Aws::Utils::DateTime m_lastUpdateTime; bool m_lastUpdateTimeHasBeenSet = false; Aws::Utils::DateTime m_lastMessageArrivalTime; bool m_lastMessageArrivalTimeHasBeenSet = false; }; } // namespace Model } // namespace IoTAnalytics } // namespace Aws