RestoreStatus

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

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Functions

Link copied to clipboard
inline fun copy(block: RestoreStatus.Builder.() -> Unit = {}): RestoreStatus
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String