software.amazon.awssdk.services.redshift.model

Class RestoreStatus

java.lang.Object

software.amazon.awssdk.services.redshift.model.RestoreStatus

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RestoreStatus.Builder,RestoreStatus>

@Generated(value="software.amazon.awssdk:codegen")
public final class RestoreStatus
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RestoreStatus.Builder,RestoreStatus>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RestoreStatus.Builder

Method Summary

Modifier and Type	Method and Description
static RestoreStatus.Builder	builder()
Double	currentRestoreRateInMegaBytesPerSecond() The number of megabytes per second being transferred from the backup storage.
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.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Long	estimatedTimeToCompletionInSeconds() The estimate of the time remaining before the restore will complete.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Long	progressInMegaBytes() The number of megabytes that have been transferred from snapshot storage.
List<SdkField<?>>	sdkFields()
static Class<? extends RestoreStatus.Builder>	serializableBuilderClass()
Long	snapshotSizeInMegaBytes() The size of the set of snapshot data used to restore the cluster.
String	status() The status of the restore action.
RestoreStatus.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

status

public final String status()

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.

currentRestoreRateInMegaBytesPerSecond

public final Double currentRestoreRateInMegaBytesPerSecond()

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 and DS2 node types.

Returns:

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 and DS2 node types.

snapshotSizeInMegaBytes

public final Long snapshotSizeInMegaBytes()

The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

Returns:

The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

progressInMegaBytes

public final Long progressInMegaBytes()

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

Returns:

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

elapsedTimeInSeconds

public final 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. This field is only updated when you restore to DC2 and DS2 node types.

Returns:

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 and DS2 node types.

estimatedTimeToCompletionInSeconds

public final Long estimatedTimeToCompletionInSeconds()

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 and DS2 node types.

Returns:

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 and DS2 node types.

toBuilder

public RestoreStatus.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RestoreStatus.Builder,RestoreStatus>

builder

public static RestoreStatus.Builder builder()

serializableBuilderClass

public static Class<? extends RestoreStatus.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo