AWS SDK for C++  1.9.68
AWS SDK for C++
Public Member Functions | List of all members
Aws::Redshift::Model::RestoreStatus Class Reference

#include <RestoreStatus.h>

Public Member Functions

 RestoreStatus ()
 
 RestoreStatus (const Aws::Utils::Xml::XmlNode &xmlNode)
 
RestoreStatusoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const Aws::StringGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const Aws::String &value)
 
void SetStatus (Aws::String &&value)
 
void SetStatus (const char *value)
 
RestoreStatusWithStatus (const Aws::String &value)
 
RestoreStatusWithStatus (Aws::String &&value)
 
RestoreStatusWithStatus (const char *value)
 
double GetCurrentRestoreRateInMegaBytesPerSecond () const
 
bool CurrentRestoreRateInMegaBytesPerSecondHasBeenSet () const
 
void SetCurrentRestoreRateInMegaBytesPerSecond (double value)
 
RestoreStatusWithCurrentRestoreRateInMegaBytesPerSecond (double value)
 
long long GetSnapshotSizeInMegaBytes () const
 
bool SnapshotSizeInMegaBytesHasBeenSet () const
 
void SetSnapshotSizeInMegaBytes (long long value)
 
RestoreStatusWithSnapshotSizeInMegaBytes (long long value)
 
long long GetProgressInMegaBytes () const
 
bool ProgressInMegaBytesHasBeenSet () const
 
void SetProgressInMegaBytes (long long value)
 
RestoreStatusWithProgressInMegaBytes (long long value)
 
long long GetElapsedTimeInSeconds () const
 
bool ElapsedTimeInSecondsHasBeenSet () const
 
void SetElapsedTimeInSeconds (long long value)
 
RestoreStatusWithElapsedTimeInSeconds (long long value)
 
long long GetEstimatedTimeToCompletionInSeconds () const
 
bool EstimatedTimeToCompletionInSecondsHasBeenSet () const
 
void SetEstimatedTimeToCompletionInSeconds (long long value)
 
RestoreStatusWithEstimatedTimeToCompletionInSeconds (long long value)
 

Detailed Description

Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.

See Also:

AWS API Reference

Definition at line 32 of file RestoreStatus.h.

Constructor & Destructor Documentation

◆ RestoreStatus() [1/2]

Aws::Redshift::Model::RestoreStatus::RestoreStatus ( )

◆ RestoreStatus() [2/2]

Aws::Redshift::Model::RestoreStatus::RestoreStatus ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ CurrentRestoreRateInMegaBytesPerSecondHasBeenSet()

bool Aws::Redshift::Model::RestoreStatus::CurrentRestoreRateInMegaBytesPerSecondHasBeenSet ( ) const
inline

The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.

Definition at line 104 of file RestoreStatus.h.

◆ ElapsedTimeInSecondsHasBeenSet()

bool Aws::Redshift::Model::RestoreStatus::ElapsedTimeInSecondsHasBeenSet ( ) const
inline

The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.

Definition at line 183 of file RestoreStatus.h.

◆ EstimatedTimeToCompletionInSecondsHasBeenSet()

bool Aws::Redshift::Model::RestoreStatus::EstimatedTimeToCompletionInSecondsHasBeenSet ( ) const
inline

The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.

Definition at line 212 of file RestoreStatus.h.

◆ GetCurrentRestoreRateInMegaBytesPerSecond()

double Aws::Redshift::Model::RestoreStatus::GetCurrentRestoreRateInMegaBytesPerSecond ( ) const
inline

The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.

Definition at line 97 of file RestoreStatus.h.

◆ GetElapsedTimeInSeconds()

long long Aws::Redshift::Model::RestoreStatus::GetElapsedTimeInSeconds ( ) const
inline

The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.

Definition at line 176 of file RestoreStatus.h.

◆ GetEstimatedTimeToCompletionInSeconds()

long long Aws::Redshift::Model::RestoreStatus::GetEstimatedTimeToCompletionInSeconds ( ) const
inline

The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.

Definition at line 205 of file RestoreStatus.h.

◆ GetProgressInMegaBytes()

long long Aws::Redshift::Model::RestoreStatus::GetProgressInMegaBytes ( ) const
inline

The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

Definition at line 150 of file RestoreStatus.h.

◆ GetSnapshotSizeInMegaBytes()

long long Aws::Redshift::Model::RestoreStatus::GetSnapshotSizeInMegaBytes ( ) const
inline

The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

Definition at line 125 of file RestoreStatus.h.

◆ GetStatus()

const Aws::String& Aws::Redshift::Model::RestoreStatus::GetStatus ( ) const
inline

The status of the restore action. Returns starting, restoring, completed, or failed.

Definition at line 47 of file RestoreStatus.h.

◆ operator=()

RestoreStatus& Aws::Redshift::Model::RestoreStatus::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::Redshift::Model::RestoreStatus::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

void Aws::Redshift::Model::RestoreStatus::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ ProgressInMegaBytesHasBeenSet()

bool Aws::Redshift::Model::RestoreStatus::ProgressInMegaBytesHasBeenSet ( ) const
inline

The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

Definition at line 156 of file RestoreStatus.h.

◆ SetCurrentRestoreRateInMegaBytesPerSecond()

void Aws::Redshift::Model::RestoreStatus::SetCurrentRestoreRateInMegaBytesPerSecond ( double  value)
inline

The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.

Definition at line 111 of file RestoreStatus.h.

◆ SetElapsedTimeInSeconds()

void Aws::Redshift::Model::RestoreStatus::SetElapsedTimeInSeconds ( long long  value)
inline

The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.

Definition at line 190 of file RestoreStatus.h.

◆ SetEstimatedTimeToCompletionInSeconds()

void Aws::Redshift::Model::RestoreStatus::SetEstimatedTimeToCompletionInSeconds ( long long  value)
inline

The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.

Definition at line 219 of file RestoreStatus.h.

◆ SetProgressInMegaBytes()

void Aws::Redshift::Model::RestoreStatus::SetProgressInMegaBytes ( long long  value)
inline

The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

Definition at line 162 of file RestoreStatus.h.

◆ SetSnapshotSizeInMegaBytes()

void Aws::Redshift::Model::RestoreStatus::SetSnapshotSizeInMegaBytes ( long long  value)
inline

The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

Definition at line 137 of file RestoreStatus.h.

◆ SetStatus() [1/3]

void Aws::Redshift::Model::RestoreStatus::SetStatus ( Aws::String &&  value)
inline

The status of the restore action. Returns starting, restoring, completed, or failed.

Definition at line 65 of file RestoreStatus.h.

◆ SetStatus() [2/3]

void Aws::Redshift::Model::RestoreStatus::SetStatus ( const Aws::String value)
inline

The status of the restore action. Returns starting, restoring, completed, or failed.

Definition at line 59 of file RestoreStatus.h.

◆ SetStatus() [3/3]

void Aws::Redshift::Model::RestoreStatus::SetStatus ( const char *  value)
inline

The status of the restore action. Returns starting, restoring, completed, or failed.

Definition at line 71 of file RestoreStatus.h.

◆ SnapshotSizeInMegaBytesHasBeenSet()

bool Aws::Redshift::Model::RestoreStatus::SnapshotSizeInMegaBytesHasBeenSet ( ) const
inline

The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

Definition at line 131 of file RestoreStatus.h.

◆ StatusHasBeenSet()

bool Aws::Redshift::Model::RestoreStatus::StatusHasBeenSet ( ) const
inline

The status of the restore action. Returns starting, restoring, completed, or failed.

Definition at line 53 of file RestoreStatus.h.

◆ WithCurrentRestoreRateInMegaBytesPerSecond()

RestoreStatus& Aws::Redshift::Model::RestoreStatus::WithCurrentRestoreRateInMegaBytesPerSecond ( double  value)
inline

The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.

Definition at line 118 of file RestoreStatus.h.

◆ WithElapsedTimeInSeconds()

RestoreStatus& Aws::Redshift::Model::RestoreStatus::WithElapsedTimeInSeconds ( long long  value)
inline

The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.

Definition at line 197 of file RestoreStatus.h.

◆ WithEstimatedTimeToCompletionInSeconds()

RestoreStatus& Aws::Redshift::Model::RestoreStatus::WithEstimatedTimeToCompletionInSeconds ( long long  value)
inline

The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.

Definition at line 226 of file RestoreStatus.h.

◆ WithProgressInMegaBytes()

RestoreStatus& Aws::Redshift::Model::RestoreStatus::WithProgressInMegaBytes ( long long  value)
inline

The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

Definition at line 168 of file RestoreStatus.h.

◆ WithSnapshotSizeInMegaBytes()

RestoreStatus& Aws::Redshift::Model::RestoreStatus::WithSnapshotSizeInMegaBytes ( long long  value)
inline

The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

Definition at line 143 of file RestoreStatus.h.

◆ WithStatus() [1/3]

RestoreStatus& Aws::Redshift::Model::RestoreStatus::WithStatus ( Aws::String &&  value)
inline

The status of the restore action. Returns starting, restoring, completed, or failed.

Definition at line 83 of file RestoreStatus.h.

◆ WithStatus() [2/3]

RestoreStatus& Aws::Redshift::Model::RestoreStatus::WithStatus ( const Aws::String value)
inline

The status of the restore action. Returns starting, restoring, completed, or failed.

Definition at line 77 of file RestoreStatus.h.

◆ WithStatus() [3/3]

RestoreStatus& Aws::Redshift::Model::RestoreStatus::WithStatus ( const char *  value)
inline

The status of the restore action. Returns starting, restoring, completed, or failed.

Definition at line 89 of file RestoreStatus.h.


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