com.amazonaws.services.redshift.model

Class RestoreStatus

java.lang.Object

com.amazonaws.services.redshift.model.RestoreStatus

All Implemented Interfaces:

Serializable, Cloneable

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:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RestoreStatus()

Method Summary

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

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RestoreStatus

public RestoreStatus()

Method Detail

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.

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.

withStatus

public RestoreStatus withStatus(String status)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

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.

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.

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

currentRestoreRateInMegaBytesPerSecond - The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.

Returns:

A reference to this updated object so that method calls can be chained together.

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.

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.

withSnapshotSizeInMegaBytes

public RestoreStatus withSnapshotSizeInMegaBytes(Long snapshotSizeInMegaBytes)

The size of the set of snapshot data used to restore the cluster.

Returns a reference to this object so that method calls can be chained together.

Parameters:

snapshotSizeInMegaBytes - The size of the set of snapshot data used to restore the cluster.

Returns:

A reference to this updated object so that method calls can be chained together.

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.

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.

withProgressInMegaBytes

public RestoreStatus withProgressInMegaBytes(Long progressInMegaBytes)

The number of megabytes that have been transferred from snapshot storage.

Returns a reference to this object so that method calls can be chained together.

Parameters:

progressInMegaBytes - The number of megabytes that have been transferred from snapshot storage.

Returns:

A reference to this updated object so that method calls can be chained together.

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.

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.

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.

Returns a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

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.

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.

withEstimatedTimeToCompletionInSeconds

public RestoreStatus withEstimatedTimeToCompletionInSeconds(Long estimatedTimeToCompletionInSeconds)

The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.

Returns a reference to this object so that method calls can be chained together.

Parameters:

estimatedTimeToCompletionInSeconds - The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.

Returns:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public RestoreStatus clone()

Overrides:

clone in class Object