RestoreStatus (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.redshift.model.RestoreStatus

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RestoreStatus
extends Object
implements Serializable, Cloneable
```
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RestoreStatus()

Constructors
Constructor and Description
`RestoreStatus()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RestoreStatus`	`clone()`
`boolean`	`equals(Object obj)`
`Double`	`getCurrentRestoreRateInMegaBytesPerSecond()` The number of megabytes per second being transferred from the backup storage.
`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.
`Long`	`getEstimatedTimeToCompletionInSeconds()` The estimate of the time remaining before the restore will complete.
`Long`	`getProgressInMegaBytes()` The number of megabytes that have been transferred from snapshot storage.
`Long`	`getSnapshotSizeInMegaBytes()` The size of the set of snapshot data used to restore the cluster.
`String`	`getStatus()` 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`	`setStatus(String status)` The status of the restore action.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`RestoreStatus`	`withCurrentRestoreRateInMegaBytesPerSecond(Double currentRestoreRateInMegaBytesPerSecond)` The number of megabytes per second being transferred from the backup storage.
`RestoreStatus`	`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.
`RestoreStatus`	`withEstimatedTimeToCompletionInSeconds(Long estimatedTimeToCompletionInSeconds)` The estimate of the time remaining before the restore will complete.
`RestoreStatus`	`withProgressInMegaBytes(Long progressInMegaBytes)` The number of megabytes that have been transferred from snapshot storage.
`RestoreStatus`	`withSnapshotSizeInMegaBytes(Long snapshotSizeInMegaBytes)` The size of the set of snapshot data used to restore the cluster.
`RestoreStatus`	`withStatus(String status)` The status of the restore action.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RestoreStatus
```
public RestoreStatus()
```
- Method Detail
  - setStatus
```
public void setStatus(String status)
```
    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
```
public String 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
```
public RestoreStatus withStatus(String status)
```
    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
```
public Double 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
```
public void setSnapshotSizeInMegaBytes(Long snapshotSizeInMegaBytes)
```
    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
```
public Long 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
```
public RestoreStatus withSnapshotSizeInMegaBytes(Long snapshotSizeInMegaBytes)
```
    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
```
public void setProgressInMegaBytes(Long progressInMegaBytes)
```
    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
```
public Long 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
```
public RestoreStatus withProgressInMegaBytes(Long progressInMegaBytes)
```
    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
```
public 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.
    
    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
```
public 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.
    
    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
```
public RestoreStatus 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.
    
    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
```
public void setEstimatedTimeToCompletionInSeconds(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.
  - getEstimatedTimeToCompletionInSeconds
```
public Long 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
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public RestoreStatus clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class RestoreStatus

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RestoreStatus

Method Detail

setStatus

getStatus

withStatus

setCurrentRestoreRateInMegaBytesPerSecond

getCurrentRestoreRateInMegaBytesPerSecond

withCurrentRestoreRateInMegaBytesPerSecond

setSnapshotSizeInMegaBytes

getSnapshotSizeInMegaBytes

withSnapshotSizeInMegaBytes

setProgressInMegaBytes

getProgressInMegaBytes

withProgressInMegaBytes

setElapsedTimeInSeconds

getElapsedTimeInSeconds

withElapsedTimeInSeconds

setEstimatedTimeToCompletionInSeconds

getEstimatedTimeToCompletionInSeconds

withEstimatedTimeToCompletionInSeconds

toString

equals

hashCode

clone