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

#include <Datastore.h>

Public Member Functions

 Datastore ()
 
 Datastore (Aws::Utils::Json::JsonView jsonValue)
 
Datastoreoperator= (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)
 
DatastoreWithName (const Aws::String &value)
 
DatastoreWithName (Aws::String &&value)
 
DatastoreWithName (const char *value)
 
const DatastoreStorageGetStorage () const
 
bool StorageHasBeenSet () const
 
void SetStorage (const DatastoreStorage &value)
 
void SetStorage (DatastoreStorage &&value)
 
DatastoreWithStorage (const DatastoreStorage &value)
 
DatastoreWithStorage (DatastoreStorage &&value)
 
const Aws::StringGetArn () const
 
bool ArnHasBeenSet () const
 
void SetArn (const Aws::String &value)
 
void SetArn (Aws::String &&value)
 
void SetArn (const char *value)
 
DatastoreWithArn (const Aws::String &value)
 
DatastoreWithArn (Aws::String &&value)
 
DatastoreWithArn (const char *value)
 
const DatastoreStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const DatastoreStatus &value)
 
void SetStatus (DatastoreStatus &&value)
 
DatastoreWithStatus (const DatastoreStatus &value)
 
DatastoreWithStatus (DatastoreStatus &&value)
 
const RetentionPeriodGetRetentionPeriod () const
 
bool RetentionPeriodHasBeenSet () const
 
void SetRetentionPeriod (const RetentionPeriod &value)
 
void SetRetentionPeriod (RetentionPeriod &&value)
 
DatastoreWithRetentionPeriod (const RetentionPeriod &value)
 
DatastoreWithRetentionPeriod (RetentionPeriod &&value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
bool CreationTimeHasBeenSet () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
DatastoreWithCreationTime (const Aws::Utils::DateTime &value)
 
DatastoreWithCreationTime (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)
 
DatastoreWithLastUpdateTime (const Aws::Utils::DateTime &value)
 
DatastoreWithLastUpdateTime (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)
 
DatastoreWithLastMessageArrivalTime (const Aws::Utils::DateTime &value)
 
DatastoreWithLastMessageArrivalTime (Aws::Utils::DateTime &&value)
 

Detailed Description

Information about a data store.

See Also:

AWS API Reference

Definition at line 35 of file Datastore.h.

Constructor & Destructor Documentation

◆ Datastore() [1/2]

Aws::IoTAnalytics::Model::Datastore::Datastore ( )

◆ Datastore() [2/2]

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

Member Function Documentation

◆ ArnHasBeenSet()

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

The ARN of the data store.

Definition at line 142 of file Datastore.h.

◆ CreationTimeHasBeenSet()

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

When the data store was created.

Definition at line 275 of file Datastore.h.

◆ GetArn()

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

The ARN of the data store.

Definition at line 137 of file Datastore.h.

◆ GetCreationTime()

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

When the data store was created.

Definition at line 270 of file Datastore.h.

◆ GetLastMessageArrivalTime()

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

The last time when a new message arrived in the data store.

AWS IoT Analytics updates this value at most once per minute for one data store. 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 336 of file Datastore.h.

◆ GetLastUpdateTime()

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

The last time the data store was updated.

Definition at line 301 of file Datastore.h.

◆ GetName()

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

The name of the data store.

Definition at line 47 of file Datastore.h.

◆ GetRetentionPeriod()

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

How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.

Definition at line 229 of file Datastore.h.

◆ GetStatus()

const DatastoreStatus& Aws::IoTAnalytics::Model::Datastore::GetStatus ( ) const
inline

The status of a data store:

CREATING

The data store is being created.

ACTIVE

The data store has been created and can be used.

DELETING

The data store is being deleted.

Definition at line 181 of file Datastore.h.

◆ GetStorage()

const DatastoreStorage& Aws::IoTAnalytics::Model::Datastore::GetStorage ( ) const
inline

Where data store 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 data store is created.

Definition at line 91 of file Datastore.h.

◆ Jsonize()

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

◆ LastMessageArrivalTimeHasBeenSet()

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

The last time when a new message arrived in the data store.

AWS IoT Analytics updates this value at most once per minute for one data store. 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 345 of file Datastore.h.

◆ LastUpdateTimeHasBeenSet()

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

The last time the data store was updated.

Definition at line 306 of file Datastore.h.

◆ NameHasBeenSet()

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

The name of the data store.

Definition at line 52 of file Datastore.h.

◆ operator=()

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

◆ RetentionPeriodHasBeenSet()

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

How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.

Definition at line 236 of file Datastore.h.

◆ SetArn() [1/3]

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

The ARN of the data store.

Definition at line 147 of file Datastore.h.

◆ SetArn() [2/3]

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

The ARN of the data store.

Definition at line 152 of file Datastore.h.

◆ SetArn() [3/3]

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

The ARN of the data store.

Definition at line 157 of file Datastore.h.

◆ SetCreationTime() [1/2]

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

When the data store was created.

Definition at line 280 of file Datastore.h.

◆ SetCreationTime() [2/2]

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

When the data store was created.

Definition at line 285 of file Datastore.h.

◆ SetLastMessageArrivalTime() [1/2]

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

The last time when a new message arrived in the data store.

AWS IoT Analytics updates this value at most once per minute for one data store. 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 354 of file Datastore.h.

◆ SetLastMessageArrivalTime() [2/2]

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

The last time when a new message arrived in the data store.

AWS IoT Analytics updates this value at most once per minute for one data store. 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 363 of file Datastore.h.

◆ SetLastUpdateTime() [1/2]

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

The last time the data store was updated.

Definition at line 311 of file Datastore.h.

◆ SetLastUpdateTime() [2/2]

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

The last time the data store was updated.

Definition at line 316 of file Datastore.h.

◆ SetName() [1/3]

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

The name of the data store.

Definition at line 57 of file Datastore.h.

◆ SetName() [2/3]

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

The name of the data store.

Definition at line 62 of file Datastore.h.

◆ SetName() [3/3]

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

The name of the data store.

Definition at line 67 of file Datastore.h.

◆ SetRetentionPeriod() [1/2]

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

How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.

Definition at line 243 of file Datastore.h.

◆ SetRetentionPeriod() [2/2]

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

How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.

Definition at line 250 of file Datastore.h.

◆ SetStatus() [1/2]

void Aws::IoTAnalytics::Model::Datastore::SetStatus ( const DatastoreStatus value)
inline

The status of a data store:

CREATING

The data store is being created.

ACTIVE

The data store has been created and can be used.

DELETING

The data store is being deleted.

Definition at line 197 of file Datastore.h.

◆ SetStatus() [2/2]

void Aws::IoTAnalytics::Model::Datastore::SetStatus ( DatastoreStatus &&  value)
inline

The status of a data store:

CREATING

The data store is being created.

ACTIVE

The data store has been created and can be used.

DELETING

The data store is being deleted.

Definition at line 205 of file Datastore.h.

◆ SetStorage() [1/2]

void Aws::IoTAnalytics::Model::Datastore::SetStorage ( const DatastoreStorage value)
inline

Where data store 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 data store is created.

Definition at line 107 of file Datastore.h.

◆ SetStorage() [2/2]

void Aws::IoTAnalytics::Model::Datastore::SetStorage ( DatastoreStorage &&  value)
inline

Where data store 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 data store is created.

Definition at line 115 of file Datastore.h.

◆ StatusHasBeenSet()

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

The status of a data store:

CREATING

The data store is being created.

ACTIVE

The data store has been created and can be used.

DELETING

The data store is being deleted.

Definition at line 189 of file Datastore.h.

◆ StorageHasBeenSet()

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

Where data store 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 data store is created.

Definition at line 99 of file Datastore.h.

◆ WithArn() [1/3]

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

The ARN of the data store.

Definition at line 162 of file Datastore.h.

◆ WithArn() [2/3]

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

The ARN of the data store.

Definition at line 167 of file Datastore.h.

◆ WithArn() [3/3]

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

The ARN of the data store.

Definition at line 172 of file Datastore.h.

◆ WithCreationTime() [1/2]

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

When the data store was created.

Definition at line 290 of file Datastore.h.

◆ WithCreationTime() [2/2]

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

When the data store was created.

Definition at line 295 of file Datastore.h.

◆ WithLastMessageArrivalTime() [1/2]

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

The last time when a new message arrived in the data store.

AWS IoT Analytics updates this value at most once per minute for one data store. 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 372 of file Datastore.h.

◆ WithLastMessageArrivalTime() [2/2]

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

The last time when a new message arrived in the data store.

AWS IoT Analytics updates this value at most once per minute for one data store. 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 381 of file Datastore.h.

◆ WithLastUpdateTime() [1/2]

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

The last time the data store was updated.

Definition at line 321 of file Datastore.h.

◆ WithLastUpdateTime() [2/2]

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

The last time the data store was updated.

Definition at line 326 of file Datastore.h.

◆ WithName() [1/3]

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

The name of the data store.

Definition at line 72 of file Datastore.h.

◆ WithName() [2/3]

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

The name of the data store.

Definition at line 77 of file Datastore.h.

◆ WithName() [3/3]

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

The name of the data store.

Definition at line 82 of file Datastore.h.

◆ WithRetentionPeriod() [1/2]

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

How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.

Definition at line 257 of file Datastore.h.

◆ WithRetentionPeriod() [2/2]

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

How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.

Definition at line 264 of file Datastore.h.

◆ WithStatus() [1/2]

Datastore& Aws::IoTAnalytics::Model::Datastore::WithStatus ( const DatastoreStatus value)
inline

The status of a data store:

CREATING

The data store is being created.

ACTIVE

The data store has been created and can be used.

DELETING

The data store is being deleted.

Definition at line 213 of file Datastore.h.

◆ WithStatus() [2/2]

Datastore& Aws::IoTAnalytics::Model::Datastore::WithStatus ( DatastoreStatus &&  value)
inline

The status of a data store:

CREATING

The data store is being created.

ACTIVE

The data store has been created and can be used.

DELETING

The data store is being deleted.

Definition at line 221 of file Datastore.h.

◆ WithStorage() [1/2]

Datastore& Aws::IoTAnalytics::Model::Datastore::WithStorage ( const DatastoreStorage value)
inline

Where data store 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 data store is created.

Definition at line 123 of file Datastore.h.

◆ WithStorage() [2/2]

Datastore& Aws::IoTAnalytics::Model::Datastore::WithStorage ( DatastoreStorage &&  value)
inline

Where data store 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 data store is created.

Definition at line 131 of file Datastore.h.


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