Class RestoreStatus
- All Implemented Interfaces:
Serializable
,Cloneable
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The number of megabytes per second being transferred from the backup storage.The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.The estimate of the time remaining before the restore will complete.The number of megabytes that have been transferred from snapshot storage.The size of the set of snapshot data used to restore the cluster.The status of the restore action.int
hashCode()
void
setCurrentRestoreRateInMegaBytesPerSecond
(Double currentRestoreRateInMegaBytesPerSecond) The number of megabytes per second being transferred from the backup storage.void
setElapsedTimeInSeconds
(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
(Long estimatedTimeToCompletionInSeconds) The estimate of the time remaining before the restore will complete.void
setProgressInMegaBytes
(Long progressInMegaBytes) The number of megabytes that have been transferred from snapshot storage.void
setSnapshotSizeInMegaBytes
(Long snapshotSizeInMegaBytes) The size of the set of snapshot data used to restore the cluster.void
The status of the restore action.toString()
Returns a string representation of this object; useful for testing and debugging.withCurrentRestoreRateInMegaBytesPerSecond
(Double currentRestoreRateInMegaBytesPerSecond) The number of megabytes per second being transferred from the backup storage.withElapsedTimeInSeconds
(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.withEstimatedTimeToCompletionInSeconds
(Long estimatedTimeToCompletionInSeconds) The estimate of the time remaining before the restore will complete.withProgressInMegaBytes
(Long progressInMegaBytes) The number of megabytes that have been transferred from snapshot storage.withSnapshotSizeInMegaBytes
(Long snapshotSizeInMegaBytes) The size of the set of snapshot data used to restore the cluster.withStatus
(String status) The status of the restore action.
-
Constructor Details
-
RestoreStatus
public RestoreStatus()
-
-
Method Details
-
setStatus
The status of the restore action. Returns starting, restoring, completed, or failed.
- Parameters:
status
- The status of the restore action. Returns starting, restoring, completed, or failed.
-
getStatus
The status of the restore action. Returns starting, restoring, completed, or failed.
- Returns:
- The status of the restore action. Returns starting, restoring, completed, or failed.
-
withStatus
The status of the restore action. Returns starting, restoring, completed, or failed.
- Parameters:
status
- The status of the restore action. Returns starting, restoring, completed, or failed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCurrentRestoreRateInMegaBytesPerSecond
public void setCurrentRestoreRateInMegaBytesPerSecond(Double currentRestoreRateInMegaBytesPerSecond) The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
- Parameters:
currentRestoreRateInMegaBytesPerSecond
- The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
-
getCurrentRestoreRateInMegaBytesPerSecond
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
- Returns:
- The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
-
withCurrentRestoreRateInMegaBytesPerSecond
public RestoreStatus withCurrentRestoreRateInMegaBytesPerSecond(Double currentRestoreRateInMegaBytesPerSecond) The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
- Parameters:
currentRestoreRateInMegaBytesPerSecond
- The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSnapshotSizeInMegaBytes
The size of the set of snapshot data used to restore the cluster.
- Parameters:
snapshotSizeInMegaBytes
- The size of the set of snapshot data used to restore the cluster.
-
getSnapshotSizeInMegaBytes
The size of the set of snapshot data used to restore the cluster.
- Returns:
- The size of the set of snapshot data used to restore the cluster.
-
withSnapshotSizeInMegaBytes
The size of the set of snapshot data used to restore the cluster.
- Parameters:
snapshotSizeInMegaBytes
- The size of the set of snapshot data used to restore the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setProgressInMegaBytes
The number of megabytes that have been transferred from snapshot storage.
- Parameters:
progressInMegaBytes
- The number of megabytes that have been transferred from snapshot storage.
-
getProgressInMegaBytes
The number of megabytes that have been transferred from snapshot storage.
- Returns:
- The number of megabytes that have been transferred from snapshot storage.
-
withProgressInMegaBytes
The number of megabytes that have been transferred from snapshot storage.
- Parameters:
progressInMegaBytes
- The number of megabytes that have been transferred from snapshot storage.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setElapsedTimeInSeconds
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
- Parameters:
elapsedTimeInSeconds
- The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
-
getElapsedTimeInSeconds
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
- Returns:
- The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
-
withElapsedTimeInSeconds
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
- Parameters:
elapsedTimeInSeconds
- The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEstimatedTimeToCompletionInSeconds
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
- Parameters:
estimatedTimeToCompletionInSeconds
- The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
-
getEstimatedTimeToCompletionInSeconds
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
- Returns:
- The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
-
withEstimatedTimeToCompletionInSeconds
public RestoreStatus withEstimatedTimeToCompletionInSeconds(Long estimatedTimeToCompletionInSeconds) The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
- Parameters:
estimatedTimeToCompletionInSeconds
- The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-