Class DescribeResizeResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.redshift.model.RedshiftResponse
software.amazon.awssdk.services.redshift.model.DescribeResizeResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeResizeResponse.Builder,DescribeResizeResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeResizeResponse extends RedshiftResponse implements ToCopyableBuilder<DescribeResizeResponse.Builder,DescribeResizeResponse>

Describes the result of a cluster resize operation.

  • Method Details

    • targetNodeType

      public final String targetNodeType()

      The node type that the cluster will have after the resize operation is complete.

      Returns:
      The node type that the cluster will have after the resize operation is complete.

    • targetNumberOfNodes

      public final Integer targetNumberOfNodes()

      The number of nodes that the cluster will have after the resize operation is complete.

      Returns:
      The number of nodes that the cluster will have after the resize operation is complete.

    • targetClusterType

      public final String targetClusterType()

      The cluster type after the resize operation is complete.

      Valid Values: multi-node | single-node

      Returns:
      The cluster type after the resize operation is complete.

      Valid Values: multi-node | single-node

    • status

      public final String status()

      The status of the resize operation.

      Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED | CANCELLING

      Returns:
      The status of the resize operation.

      Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED | CANCELLING

    • hasImportTablesCompleted

      public final boolean hasImportTablesCompleted()
      For responses, this returns true if the service returned a value for the ImportTablesCompleted property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • importTablesCompleted

      public final List<String> importTablesCompleted()

      The names of tables that have been completely imported .

      Valid Values: List of table names.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasImportTablesCompleted() method.

      Returns:
      The names of tables that have been completely imported .

      Valid Values: List of table names.

    • hasImportTablesInProgress

      public final boolean hasImportTablesInProgress()
      For responses, this returns true if the service returned a value for the ImportTablesInProgress property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • importTablesInProgress

      public final List<String> importTablesInProgress()

      The names of tables that are being currently imported.

      Valid Values: List of table names.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasImportTablesInProgress() method.

      Returns:
      The names of tables that are being currently imported.

      Valid Values: List of table names.

    • hasImportTablesNotStarted

      public final boolean hasImportTablesNotStarted()
      For responses, this returns true if the service returned a value for the ImportTablesNotStarted property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • importTablesNotStarted

      public final List<String> importTablesNotStarted()

      The names of tables that have not been yet imported.

      Valid Values: List of table names

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasImportTablesNotStarted() method.

      Returns:
      The names of tables that have not been yet imported.

      Valid Values: List of table names

    • avgResizeRateInMegaBytesPerSecond

      public final Double avgResizeRateInMegaBytesPerSecond()

      The average rate of the resize operation over the last few minutes, measured in megabytes per second. After the resize operation completes, this value shows the average rate of the entire resize operation.

      Returns:
      The average rate of the resize operation over the last few minutes, measured in megabytes per second. After the resize operation completes, this value shows the average rate of the entire resize operation.

    • totalResizeDataInMegaBytes

      public final Long totalResizeDataInMegaBytes()

      The estimated total amount of data, in megabytes, on the cluster before the resize operation began.

      Returns:
      The estimated total amount of data, in megabytes, on the cluster before the resize operation began.

    • progressInMegaBytes

      public final Long progressInMegaBytes()

      While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize).

      Returns:
      While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize).

    • elapsedTimeInSeconds

      public final Long elapsedTimeInSeconds()

      The amount of seconds that have elapsed since the resize operation began. After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation.

      Returns:
      The amount of seconds that have elapsed since the resize operation began. After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation.

    • estimatedTimeToCompletionInSeconds

      public final Long estimatedTimeToCompletionInSeconds()

      The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0.

      Returns:
      The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0.

    • resizeType

      public final String resizeType()

      An enum with possible values of ClassicResize and ElasticResize. These values describe the type of resize operation being performed.

      Returns:
      An enum with possible values of ClassicResize and ElasticResize. These values describe the type of resize operation being performed.

    • message

      public final String message()

      An optional string to provide additional details about the resize action.

      Returns:
      An optional string to provide additional details about the resize action.

    • targetEncryptionType

      public final String targetEncryptionType()

      The type of encryption for the cluster after the resize is complete.

      Possible values are KMS and None.

      Returns:
      The type of encryption for the cluster after the resize is complete.

      Possible values are KMS and None.

    • dataTransferProgressPercent

      public final Double dataTransferProgressPercent()

      The percent of data transferred from source cluster to target cluster.

      Returns:
      The percent of data transferred from source cluster to target cluster.

    • toBuilder

      public DescribeResizeResponse.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<DescribeResizeResponse.Builder,DescribeResizeResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeResizeResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.