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

#include <ChannelSummary.h>

Public Member Functions

 ChannelSummary ()
 
 ChannelSummary (Aws::Utils::Json::JsonView jsonValue)
 
ChannelSummaryoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetChannelName () const
 
bool ChannelNameHasBeenSet () const
 
void SetChannelName (const Aws::String &value)
 
void SetChannelName (Aws::String &&value)
 
void SetChannelName (const char *value)
 
ChannelSummaryWithChannelName (const Aws::String &value)
 
ChannelSummaryWithChannelName (Aws::String &&value)
 
ChannelSummaryWithChannelName (const char *value)
 
const ChannelStorageSummaryGetChannelStorage () const
 
bool ChannelStorageHasBeenSet () const
 
void SetChannelStorage (const ChannelStorageSummary &value)
 
void SetChannelStorage (ChannelStorageSummary &&value)
 
ChannelSummaryWithChannelStorage (const ChannelStorageSummary &value)
 
ChannelSummaryWithChannelStorage (ChannelStorageSummary &&value)
 
const ChannelStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const ChannelStatus &value)
 
void SetStatus (ChannelStatus &&value)
 
ChannelSummaryWithStatus (const ChannelStatus &value)
 
ChannelSummaryWithStatus (ChannelStatus &&value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
bool CreationTimeHasBeenSet () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
ChannelSummaryWithCreationTime (const Aws::Utils::DateTime &value)
 
ChannelSummaryWithCreationTime (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)
 
ChannelSummaryWithLastUpdateTime (const Aws::Utils::DateTime &value)
 
ChannelSummaryWithLastUpdateTime (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)
 
ChannelSummaryWithLastMessageArrivalTime (const Aws::Utils::DateTime &value)
 
ChannelSummaryWithLastMessageArrivalTime (Aws::Utils::DateTime &&value)
 

Detailed Description

A summary of information about a channel.

See Also:

AWS API Reference

Definition at line 34 of file ChannelSummary.h.

Constructor & Destructor Documentation

◆ ChannelSummary() [1/2]

Aws::IoTAnalytics::Model::ChannelSummary::ChannelSummary ( )

◆ ChannelSummary() [2/2]

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

Member Function Documentation

◆ ChannelNameHasBeenSet()

bool Aws::IoTAnalytics::Model::ChannelSummary::ChannelNameHasBeenSet ( ) const
inline

The name of the channel.

Definition at line 51 of file ChannelSummary.h.

◆ ChannelStorageHasBeenSet()

bool Aws::IoTAnalytics::Model::ChannelSummary::ChannelStorageHasBeenSet ( ) const
inline

Where channel data is stored.

Definition at line 92 of file ChannelSummary.h.

◆ CreationTimeHasBeenSet()

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

When the channel was created.

Definition at line 154 of file ChannelSummary.h.

◆ GetChannelName()

const Aws::String& Aws::IoTAnalytics::Model::ChannelSummary::GetChannelName ( ) const
inline

The name of the channel.

Definition at line 46 of file ChannelSummary.h.

◆ GetChannelStorage()

const ChannelStorageSummary& Aws::IoTAnalytics::Model::ChannelSummary::GetChannelStorage ( ) const
inline

Where channel data is stored.

Definition at line 87 of file ChannelSummary.h.

◆ GetCreationTime()

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

When the channel was created.

Definition at line 149 of file ChannelSummary.h.

◆ GetLastMessageArrivalTime()

const Aws::Utils::DateTime& Aws::IoTAnalytics::Model::ChannelSummary::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 215 of file ChannelSummary.h.

◆ GetLastUpdateTime()

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

The last time the channel was updated.

Definition at line 180 of file ChannelSummary.h.

◆ GetStatus()

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

The status of the channel.

Definition at line 118 of file ChannelSummary.h.

◆ Jsonize()

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

◆ LastMessageArrivalTimeHasBeenSet()

bool Aws::IoTAnalytics::Model::ChannelSummary::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 224 of file ChannelSummary.h.

◆ LastUpdateTimeHasBeenSet()

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

The last time the channel was updated.

Definition at line 185 of file ChannelSummary.h.

◆ operator=()

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

◆ SetChannelName() [1/3]

void Aws::IoTAnalytics::Model::ChannelSummary::SetChannelName ( const Aws::String value)
inline

The name of the channel.

Definition at line 56 of file ChannelSummary.h.

◆ SetChannelName() [2/3]

void Aws::IoTAnalytics::Model::ChannelSummary::SetChannelName ( Aws::String &&  value)
inline

The name of the channel.

Definition at line 61 of file ChannelSummary.h.

◆ SetChannelName() [3/3]

void Aws::IoTAnalytics::Model::ChannelSummary::SetChannelName ( const char *  value)
inline

The name of the channel.

Definition at line 66 of file ChannelSummary.h.

◆ SetChannelStorage() [1/2]

void Aws::IoTAnalytics::Model::ChannelSummary::SetChannelStorage ( const ChannelStorageSummary value)
inline

Where channel data is stored.

Definition at line 97 of file ChannelSummary.h.

◆ SetChannelStorage() [2/2]

void Aws::IoTAnalytics::Model::ChannelSummary::SetChannelStorage ( ChannelStorageSummary &&  value)
inline

Where channel data is stored.

Definition at line 102 of file ChannelSummary.h.

◆ SetCreationTime() [1/2]

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

When the channel was created.

Definition at line 159 of file ChannelSummary.h.

◆ SetCreationTime() [2/2]

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

When the channel was created.

Definition at line 164 of file ChannelSummary.h.

◆ SetLastMessageArrivalTime() [1/2]

void Aws::IoTAnalytics::Model::ChannelSummary::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 233 of file ChannelSummary.h.

◆ SetLastMessageArrivalTime() [2/2]

void Aws::IoTAnalytics::Model::ChannelSummary::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 242 of file ChannelSummary.h.

◆ SetLastUpdateTime() [1/2]

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

The last time the channel was updated.

Definition at line 190 of file ChannelSummary.h.

◆ SetLastUpdateTime() [2/2]

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

The last time the channel was updated.

Definition at line 195 of file ChannelSummary.h.

◆ SetStatus() [1/2]

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

The status of the channel.

Definition at line 128 of file ChannelSummary.h.

◆ SetStatus() [2/2]

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

The status of the channel.

Definition at line 133 of file ChannelSummary.h.

◆ StatusHasBeenSet()

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

The status of the channel.

Definition at line 123 of file ChannelSummary.h.

◆ WithChannelName() [1/3]

ChannelSummary& Aws::IoTAnalytics::Model::ChannelSummary::WithChannelName ( const Aws::String value)
inline

The name of the channel.

Definition at line 71 of file ChannelSummary.h.

◆ WithChannelName() [2/3]

ChannelSummary& Aws::IoTAnalytics::Model::ChannelSummary::WithChannelName ( Aws::String &&  value)
inline

The name of the channel.

Definition at line 76 of file ChannelSummary.h.

◆ WithChannelName() [3/3]

ChannelSummary& Aws::IoTAnalytics::Model::ChannelSummary::WithChannelName ( const char *  value)
inline

The name of the channel.

Definition at line 81 of file ChannelSummary.h.

◆ WithChannelStorage() [1/2]

ChannelSummary& Aws::IoTAnalytics::Model::ChannelSummary::WithChannelStorage ( const ChannelStorageSummary value)
inline

Where channel data is stored.

Definition at line 107 of file ChannelSummary.h.

◆ WithChannelStorage() [2/2]

ChannelSummary& Aws::IoTAnalytics::Model::ChannelSummary::WithChannelStorage ( ChannelStorageSummary &&  value)
inline

Where channel data is stored.

Definition at line 112 of file ChannelSummary.h.

◆ WithCreationTime() [1/2]

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

When the channel was created.

Definition at line 169 of file ChannelSummary.h.

◆ WithCreationTime() [2/2]

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

When the channel was created.

Definition at line 174 of file ChannelSummary.h.

◆ WithLastMessageArrivalTime() [1/2]

ChannelSummary& Aws::IoTAnalytics::Model::ChannelSummary::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 251 of file ChannelSummary.h.

◆ WithLastMessageArrivalTime() [2/2]

ChannelSummary& Aws::IoTAnalytics::Model::ChannelSummary::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 260 of file ChannelSummary.h.

◆ WithLastUpdateTime() [1/2]

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

The last time the channel was updated.

Definition at line 200 of file ChannelSummary.h.

◆ WithLastUpdateTime() [2/2]

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

The last time the channel was updated.

Definition at line 205 of file ChannelSummary.h.

◆ WithStatus() [1/2]

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

The status of the channel.

Definition at line 138 of file ChannelSummary.h.

◆ WithStatus() [2/2]

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

The status of the channel.

Definition at line 143 of file ChannelSummary.h.


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