Struct RestoreStatus

#[non_exhaustive]
pub struct RestoreStatus {
    pub status: Option<String>,
    pub current_restore_rate_in_mega_bytes_per_second: Option<f64>,
    pub snapshot_size_in_mega_bytes: Option<i64>,
    pub progress_in_mega_bytes: Option<i64>,
    pub elapsed_time_in_seconds: Option<i64>,
    pub estimated_time_to_completion_in_seconds: Option<i64>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

status: Option<String>

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

current_restore_rate_in_mega_bytes_per_second: Option<f64>

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 node types.

snapshot_size_in_mega_bytes: Option<i64>

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

progress_in_mega_bytes: Option<i64>

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

elapsed_time_in_seconds: Option<i64>

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 node types.

estimated_time_to_completion_in_seconds: Option<i64>

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 node types.

Implementations

impl RestoreStatus

pub fn status(&self) -> Option<&str>

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

pub fn current_restore_rate_in_mega_bytes_per_second(&self) -> Option<f64>

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 node types.

pub fn snapshot_size_in_mega_bytes(&self) -> Option<i64>

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

pub fn progress_in_mega_bytes(&self) -> Option<i64>

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

pub fn elapsed_time_in_seconds(&self) -> Option<i64>

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 node types.

pub fn estimated_time_to_completion_in_seconds(&self) -> Option<i64>

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 node types.

impl RestoreStatus

pub fn builder() -> RestoreStatusBuilder

Creates a new builder-style object to manufacture RestoreStatus.

Trait Implementations

impl Clone for RestoreStatus

fn clone(&self) -> RestoreStatus

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RestoreStatus

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for RestoreStatus

fn eq(&self, other: &RestoreStatus) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RestoreStatus