public class RestoreStatus
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
Modifier and Type | Field and Description |
---|---|
private java.lang.Double |
currentRestoreRateInMegaBytesPerSecond
The number of megabytes per second being transferred from the backup
storage.
|
private java.lang.Long |
elapsedTimeInSeconds
The amount of time an in-progress restore has been running, or the amount
of time it took a completed restore to finish.
|
private java.lang.Long |
estimatedTimeToCompletionInSeconds
The estimate of the time remaining before the restore will complete.
|
private java.lang.Long |
progressInMegaBytes
The number of megabytes that have been transferred from snapshot storage.
|
private java.lang.Long |
snapshotSizeInMegaBytes
The size of the set of snapshot data used to restore the cluster.
|
private java.lang.String |
status
The status of the restore action.
|
Constructor and Description |
---|
RestoreStatus() |
Modifier and Type | Method and Description |
---|---|
RestoreStatus |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.Double |
getCurrentRestoreRateInMegaBytesPerSecond()
The number of megabytes per second being transferred from the backup
storage.
|
java.lang.Long |
getElapsedTimeInSeconds()
The amount of time an in-progress restore has been running, or the amount
of time it took a completed restore to finish.
|
java.lang.Long |
getEstimatedTimeToCompletionInSeconds()
The estimate of the time remaining before the restore will complete.
|
java.lang.Long |
getProgressInMegaBytes()
The number of megabytes that have been transferred from snapshot storage.
|
java.lang.Long |
getSnapshotSizeInMegaBytes()
The size of the set of snapshot data used to restore the cluster.
|
java.lang.String |
getStatus()
The status of the restore action.
|
int |
hashCode() |
void |
setCurrentRestoreRateInMegaBytesPerSecond(java.lang.Double currentRestoreRateInMegaBytesPerSecond)
The number of megabytes per second being transferred from the backup
storage.
|
void |
setElapsedTimeInSeconds(java.lang.Long elapsedTimeInSeconds)
The amount of time an in-progress restore has been running, or the amount
of time it took a completed restore to finish.
|
void |
setEstimatedTimeToCompletionInSeconds(java.lang.Long estimatedTimeToCompletionInSeconds)
The estimate of the time remaining before the restore will complete.
|
void |
setProgressInMegaBytes(java.lang.Long progressInMegaBytes)
The number of megabytes that have been transferred from snapshot storage.
|
void |
setSnapshotSizeInMegaBytes(java.lang.Long snapshotSizeInMegaBytes)
The size of the set of snapshot data used to restore the cluster.
|
void |
setStatus(java.lang.String status)
The status of the restore action.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
RestoreStatus |
withCurrentRestoreRateInMegaBytesPerSecond(java.lang.Double currentRestoreRateInMegaBytesPerSecond)
The number of megabytes per second being transferred from the backup
storage.
|
RestoreStatus |
withElapsedTimeInSeconds(java.lang.Long elapsedTimeInSeconds)
The amount of time an in-progress restore has been running, or the amount
of time it took a completed restore to finish.
|
RestoreStatus |
withEstimatedTimeToCompletionInSeconds(java.lang.Long estimatedTimeToCompletionInSeconds)
The estimate of the time remaining before the restore will complete.
|
RestoreStatus |
withProgressInMegaBytes(java.lang.Long progressInMegaBytes)
The number of megabytes that have been transferred from snapshot storage.
|
RestoreStatus |
withSnapshotSizeInMegaBytes(java.lang.Long snapshotSizeInMegaBytes)
The size of the set of snapshot data used to restore the cluster.
|
RestoreStatus |
withStatus(java.lang.String status)
The status of the restore action.
|
private java.lang.String status
The status of the restore action. Returns starting, restoring, completed, or failed.
private java.lang.Double currentRestoreRateInMegaBytesPerSecond
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
private java.lang.Long snapshotSizeInMegaBytes
The size of the set of snapshot data used to restore the cluster.
private java.lang.Long progressInMegaBytes
The number of megabytes that have been transferred from snapshot storage.
private java.lang.Long elapsedTimeInSeconds
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
private java.lang.Long estimatedTimeToCompletionInSeconds
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
public void setStatus(java.lang.String status)
The status of the restore action. Returns starting, restoring, completed, or failed.
status
- The status of the restore action. Returns starting, restoring,
completed, or failed.public java.lang.String getStatus()
The status of the restore action. Returns starting, restoring, completed, or failed.
public RestoreStatus withStatus(java.lang.String status)
The status of the restore action. Returns starting, restoring, completed, or failed.
status
- The status of the restore action. Returns starting, restoring,
completed, or failed.public void setCurrentRestoreRateInMegaBytesPerSecond(java.lang.Double currentRestoreRateInMegaBytesPerSecond)
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
currentRestoreRateInMegaBytesPerSecond
- The number of megabytes per second being transferred from the
backup storage. Returns the average rate for a completed backup.public java.lang.Double getCurrentRestoreRateInMegaBytesPerSecond()
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
public RestoreStatus withCurrentRestoreRateInMegaBytesPerSecond(java.lang.Double currentRestoreRateInMegaBytesPerSecond)
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
currentRestoreRateInMegaBytesPerSecond
- The number of megabytes per second being transferred from the
backup storage. Returns the average rate for a completed backup.public void setSnapshotSizeInMegaBytes(java.lang.Long snapshotSizeInMegaBytes)
The size of the set of snapshot data used to restore the cluster.
snapshotSizeInMegaBytes
- The size of the set of snapshot data used to restore the cluster.public java.lang.Long getSnapshotSizeInMegaBytes()
The size of the set of snapshot data used to restore the cluster.
public RestoreStatus withSnapshotSizeInMegaBytes(java.lang.Long snapshotSizeInMegaBytes)
The size of the set of snapshot data used to restore the cluster.
snapshotSizeInMegaBytes
- The size of the set of snapshot data used to restore the cluster.public void setProgressInMegaBytes(java.lang.Long progressInMegaBytes)
The number of megabytes that have been transferred from snapshot storage.
progressInMegaBytes
- The number of megabytes that have been transferred from snapshot
storage.public java.lang.Long getProgressInMegaBytes()
The number of megabytes that have been transferred from snapshot storage.
public RestoreStatus withProgressInMegaBytes(java.lang.Long progressInMegaBytes)
The number of megabytes that have been transferred from snapshot storage.
progressInMegaBytes
- The number of megabytes that have been transferred from snapshot
storage.public void setElapsedTimeInSeconds(java.lang.Long elapsedTimeInSeconds)
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
elapsedTimeInSeconds
- The amount of time an in-progress restore has been running, or the
amount of time it took a completed restore to finish.public java.lang.Long getElapsedTimeInSeconds()
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
public RestoreStatus withElapsedTimeInSeconds(java.lang.Long elapsedTimeInSeconds)
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
elapsedTimeInSeconds
- The amount of time an in-progress restore has been running, or the
amount of time it took a completed restore to finish.public void setEstimatedTimeToCompletionInSeconds(java.lang.Long estimatedTimeToCompletionInSeconds)
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
estimatedTimeToCompletionInSeconds
- The estimate of the time remaining before the restore will
complete. Returns 0 for a completed restore.public java.lang.Long getEstimatedTimeToCompletionInSeconds()
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
public RestoreStatus withEstimatedTimeToCompletionInSeconds(java.lang.Long estimatedTimeToCompletionInSeconds)
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
estimatedTimeToCompletionInSeconds
- The estimate of the time remaining before the restore will
complete. Returns 0 for a completed restore.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public RestoreStatus clone()
clone
in class java.lang.Object