Class RestoreStatus

java.lang.Object
software.amazon.awssdk.services.redshift.model.RestoreStatus
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RestoreStatus.Builder,RestoreStatus>
@Generated("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:

  • Method Details

    • 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 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 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 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 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 node types.

      Returns:
      The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 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 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 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 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 node types.

    • toBuilder

      public RestoreStatus.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RestoreStatus.Builder,RestoreStatus>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.