AWS SDK for C++  1.8.98
AWS SDK for C++
Public Member Functions | List of all members
Aws::IoTAnalytics::Model::Channel Class Reference

#include <Channel.h>

Public Member Functions

 Channel ()
 
 Channel (Aws::Utils::Json::JsonView jsonValue)
 
Channeloperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
ChannelWithName (const Aws::String &value)
 
ChannelWithName (Aws::String &&value)
 
ChannelWithName (const char *value)
 
const ChannelStorageGetStorage () const
 
bool StorageHasBeenSet () const
 
void SetStorage (const ChannelStorage &value)
 
void SetStorage (ChannelStorage &&value)
 
ChannelWithStorage (const ChannelStorage &value)
 
ChannelWithStorage (ChannelStorage &&value)
 
const Aws::StringGetArn () const
 
bool ArnHasBeenSet () const
 
void SetArn (const Aws::String &value)
 
void SetArn (Aws::String &&value)
 
void SetArn (const char *value)
 
ChannelWithArn (const Aws::String &value)
 
ChannelWithArn (Aws::String &&value)
 
ChannelWithArn (const char *value)
 
const ChannelStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const ChannelStatus &value)
 
void SetStatus (ChannelStatus &&value)
 
ChannelWithStatus (const ChannelStatus &value)
 
ChannelWithStatus (ChannelStatus &&value)
 
const RetentionPeriodGetRetentionPeriod () const
 
bool RetentionPeriodHasBeenSet () const
 
void SetRetentionPeriod (const RetentionPeriod &value)
 
void SetRetentionPeriod (RetentionPeriod &&value)
 
ChannelWithRetentionPeriod (const RetentionPeriod &value)
 
ChannelWithRetentionPeriod (RetentionPeriod &&value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
bool CreationTimeHasBeenSet () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
ChannelWithCreationTime (const Aws::Utils::DateTime &value)
 
ChannelWithCreationTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetLastUpdateTime () const
 
bool LastUpdateTimeHasBeenSet () const
 
void SetLastUpdateTime (const Aws::Utils::DateTime &value)
 
void SetLastUpdateTime (Aws::Utils::DateTime &&value)
 
ChannelWithLastUpdateTime (const Aws::Utils::DateTime &value)
 
ChannelWithLastUpdateTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetLastMessageArrivalTime () const
 
bool LastMessageArrivalTimeHasBeenSet () const
 
void SetLastMessageArrivalTime (const Aws::Utils::DateTime &value)
 
void SetLastMessageArrivalTime (Aws::Utils::DateTime &&value)
 
ChannelWithLastMessageArrivalTime (const Aws::Utils::DateTime &value)
 
ChannelWithLastMessageArrivalTime (Aws::Utils::DateTime &&value)
 

Detailed Description

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

Definition at line 37 of file Channel.h.

Constructor & Destructor Documentation

◆ Channel() [1/2]

Aws::IoTAnalytics::Model::Channel::Channel ( )

◆ Channel() [2/2]

Aws::IoTAnalytics::Model::Channel::Channel ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ArnHasBeenSet()

bool Aws::IoTAnalytics::Model::Channel::ArnHasBeenSet ( ) const
inline

The ARN of the channel.

Definition at line 144 of file Channel.h.

◆ CreationTimeHasBeenSet()

bool Aws::IoTAnalytics::Model::Channel::CreationTimeHasBeenSet ( ) const
inline

When the channel was created.

Definition at line 247 of file Channel.h.

◆ GetArn()

const Aws::String& Aws::IoTAnalytics::Model::Channel::GetArn ( ) const
inline

The ARN of the channel.

Definition at line 139 of file Channel.h.

◆ GetCreationTime()

const Aws::Utils::DateTime& Aws::IoTAnalytics::Model::Channel::GetCreationTime ( ) const
inline

When the channel was created.

Definition at line 242 of file Channel.h.

◆ GetLastMessageArrivalTime()

const Aws::Utils::DateTime& Aws::IoTAnalytics::Model::Channel::GetLastMessageArrivalTime ( ) const
inline

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

AWS 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.

Definition at line 308 of file Channel.h.

◆ GetLastUpdateTime()

const Aws::Utils::DateTime& Aws::IoTAnalytics::Model::Channel::GetLastUpdateTime ( ) const
inline

When the channel was last updated.

Definition at line 273 of file Channel.h.

◆ GetName()

const Aws::String& Aws::IoTAnalytics::Model::Channel::GetName ( ) const
inline

The name of the channel.

Definition at line 49 of file Channel.h.

◆ GetRetentionPeriod()

const RetentionPeriod& Aws::IoTAnalytics::Model::Channel::GetRetentionPeriod ( ) const
inline

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

Definition at line 211 of file Channel.h.

◆ GetStatus()

const ChannelStatus& Aws::IoTAnalytics::Model::Channel::GetStatus ( ) const
inline

The status of the channel.

Definition at line 180 of file Channel.h.

◆ GetStorage()

const ChannelStorage& Aws::IoTAnalytics::Model::Channel::GetStorage ( ) const
inline

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

Definition at line 93 of file Channel.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::IoTAnalytics::Model::Channel::Jsonize ( ) const

◆ LastMessageArrivalTimeHasBeenSet()

bool Aws::IoTAnalytics::Model::Channel::LastMessageArrivalTimeHasBeenSet ( ) const
inline

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

AWS 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.

Definition at line 317 of file Channel.h.

◆ LastUpdateTimeHasBeenSet()

bool Aws::IoTAnalytics::Model::Channel::LastUpdateTimeHasBeenSet ( ) const
inline

When the channel was last updated.

Definition at line 278 of file Channel.h.

◆ NameHasBeenSet()

bool Aws::IoTAnalytics::Model::Channel::NameHasBeenSet ( ) const
inline

The name of the channel.

Definition at line 54 of file Channel.h.

◆ operator=()

Channel& Aws::IoTAnalytics::Model::Channel::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RetentionPeriodHasBeenSet()

bool Aws::IoTAnalytics::Model::Channel::RetentionPeriodHasBeenSet ( ) const
inline

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

Definition at line 216 of file Channel.h.

◆ SetArn() [1/3]

void Aws::IoTAnalytics::Model::Channel::SetArn ( const Aws::String value)
inline

The ARN of the channel.

Definition at line 149 of file Channel.h.

◆ SetArn() [2/3]

void Aws::IoTAnalytics::Model::Channel::SetArn ( Aws::String &&  value)
inline

The ARN of the channel.

Definition at line 154 of file Channel.h.

◆ SetArn() [3/3]

void Aws::IoTAnalytics::Model::Channel::SetArn ( const char *  value)
inline

The ARN of the channel.

Definition at line 159 of file Channel.h.

◆ SetCreationTime() [1/2]

void Aws::IoTAnalytics::Model::Channel::SetCreationTime ( const Aws::Utils::DateTime value)
inline

When the channel was created.

Definition at line 252 of file Channel.h.

◆ SetCreationTime() [2/2]

void Aws::IoTAnalytics::Model::Channel::SetCreationTime ( Aws::Utils::DateTime &&  value)
inline

When the channel was created.

Definition at line 257 of file Channel.h.

◆ SetLastMessageArrivalTime() [1/2]

void Aws::IoTAnalytics::Model::Channel::SetLastMessageArrivalTime ( const Aws::Utils::DateTime value)
inline

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

AWS 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.

Definition at line 326 of file Channel.h.

◆ SetLastMessageArrivalTime() [2/2]

void Aws::IoTAnalytics::Model::Channel::SetLastMessageArrivalTime ( Aws::Utils::DateTime &&  value)
inline

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

AWS 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.

Definition at line 335 of file Channel.h.

◆ SetLastUpdateTime() [1/2]

void Aws::IoTAnalytics::Model::Channel::SetLastUpdateTime ( const Aws::Utils::DateTime value)
inline

When the channel was last updated.

Definition at line 283 of file Channel.h.

◆ SetLastUpdateTime() [2/2]

void Aws::IoTAnalytics::Model::Channel::SetLastUpdateTime ( Aws::Utils::DateTime &&  value)
inline

When the channel was last updated.

Definition at line 288 of file Channel.h.

◆ SetName() [1/3]

void Aws::IoTAnalytics::Model::Channel::SetName ( const Aws::String value)
inline

The name of the channel.

Definition at line 59 of file Channel.h.

◆ SetName() [2/3]

void Aws::IoTAnalytics::Model::Channel::SetName ( Aws::String &&  value)
inline

The name of the channel.

Definition at line 64 of file Channel.h.

◆ SetName() [3/3]

void Aws::IoTAnalytics::Model::Channel::SetName ( const char *  value)
inline

The name of the channel.

Definition at line 69 of file Channel.h.

◆ SetRetentionPeriod() [1/2]

void Aws::IoTAnalytics::Model::Channel::SetRetentionPeriod ( const RetentionPeriod value)
inline

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

Definition at line 221 of file Channel.h.

◆ SetRetentionPeriod() [2/2]

void Aws::IoTAnalytics::Model::Channel::SetRetentionPeriod ( RetentionPeriod &&  value)
inline

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

Definition at line 226 of file Channel.h.

◆ SetStatus() [1/2]

void Aws::IoTAnalytics::Model::Channel::SetStatus ( const ChannelStatus value)
inline

The status of the channel.

Definition at line 190 of file Channel.h.

◆ SetStatus() [2/2]

void Aws::IoTAnalytics::Model::Channel::SetStatus ( ChannelStatus &&  value)
inline

The status of the channel.

Definition at line 195 of file Channel.h.

◆ SetStorage() [1/2]

void Aws::IoTAnalytics::Model::Channel::SetStorage ( const ChannelStorage value)
inline

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

Definition at line 109 of file Channel.h.

◆ SetStorage() [2/2]

void Aws::IoTAnalytics::Model::Channel::SetStorage ( ChannelStorage &&  value)
inline

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

Definition at line 117 of file Channel.h.

◆ StatusHasBeenSet()

bool Aws::IoTAnalytics::Model::Channel::StatusHasBeenSet ( ) const
inline

The status of the channel.

Definition at line 185 of file Channel.h.

◆ StorageHasBeenSet()

bool Aws::IoTAnalytics::Model::Channel::StorageHasBeenSet ( ) const
inline

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

Definition at line 101 of file Channel.h.

◆ WithArn() [1/3]

Channel& Aws::IoTAnalytics::Model::Channel::WithArn ( const Aws::String value)
inline

The ARN of the channel.

Definition at line 164 of file Channel.h.

◆ WithArn() [2/3]

Channel& Aws::IoTAnalytics::Model::Channel::WithArn ( Aws::String &&  value)
inline

The ARN of the channel.

Definition at line 169 of file Channel.h.

◆ WithArn() [3/3]

Channel& Aws::IoTAnalytics::Model::Channel::WithArn ( const char *  value)
inline

The ARN of the channel.

Definition at line 174 of file Channel.h.

◆ WithCreationTime() [1/2]

Channel& Aws::IoTAnalytics::Model::Channel::WithCreationTime ( const Aws::Utils::DateTime value)
inline

When the channel was created.

Definition at line 262 of file Channel.h.

◆ WithCreationTime() [2/2]

Channel& Aws::IoTAnalytics::Model::Channel::WithCreationTime ( Aws::Utils::DateTime &&  value)
inline

When the channel was created.

Definition at line 267 of file Channel.h.

◆ WithLastMessageArrivalTime() [1/2]

Channel& Aws::IoTAnalytics::Model::Channel::WithLastMessageArrivalTime ( const Aws::Utils::DateTime value)
inline

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

AWS 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.

Definition at line 344 of file Channel.h.

◆ WithLastMessageArrivalTime() [2/2]

Channel& Aws::IoTAnalytics::Model::Channel::WithLastMessageArrivalTime ( Aws::Utils::DateTime &&  value)
inline

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

AWS 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.

Definition at line 353 of file Channel.h.

◆ WithLastUpdateTime() [1/2]

Channel& Aws::IoTAnalytics::Model::Channel::WithLastUpdateTime ( const Aws::Utils::DateTime value)
inline

When the channel was last updated.

Definition at line 293 of file Channel.h.

◆ WithLastUpdateTime() [2/2]

Channel& Aws::IoTAnalytics::Model::Channel::WithLastUpdateTime ( Aws::Utils::DateTime &&  value)
inline

When the channel was last updated.

Definition at line 298 of file Channel.h.

◆ WithName() [1/3]

Channel& Aws::IoTAnalytics::Model::Channel::WithName ( const Aws::String value)
inline

The name of the channel.

Definition at line 74 of file Channel.h.

◆ WithName() [2/3]

Channel& Aws::IoTAnalytics::Model::Channel::WithName ( Aws::String &&  value)
inline

The name of the channel.

Definition at line 79 of file Channel.h.

◆ WithName() [3/3]

Channel& Aws::IoTAnalytics::Model::Channel::WithName ( const char *  value)
inline

The name of the channel.

Definition at line 84 of file Channel.h.

◆ WithRetentionPeriod() [1/2]

Channel& Aws::IoTAnalytics::Model::Channel::WithRetentionPeriod ( const RetentionPeriod value)
inline

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

Definition at line 231 of file Channel.h.

◆ WithRetentionPeriod() [2/2]

Channel& Aws::IoTAnalytics::Model::Channel::WithRetentionPeriod ( RetentionPeriod &&  value)
inline

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

Definition at line 236 of file Channel.h.

◆ WithStatus() [1/2]

Channel& Aws::IoTAnalytics::Model::Channel::WithStatus ( const ChannelStatus value)
inline

The status of the channel.

Definition at line 200 of file Channel.h.

◆ WithStatus() [2/2]

Channel& Aws::IoTAnalytics::Model::Channel::WithStatus ( ChannelStatus &&  value)
inline

The status of the channel.

Definition at line 205 of file Channel.h.

◆ WithStorage() [1/2]

Channel& Aws::IoTAnalytics::Model::Channel::WithStorage ( const ChannelStorage value)
inline

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

Definition at line 125 of file Channel.h.

◆ WithStorage() [2/2]

Channel& Aws::IoTAnalytics::Model::Channel::WithStorage ( ChannelStorage &&  value)
inline

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

Definition at line 133 of file Channel.h.


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