Class ClusterOperationScalingDetails

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.ClusterOperationScalingDetails
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ClusterOperationScalingDetails.Builder,ClusterOperationScalingDetails>
@Generated("software.amazon.awssdk:codegen") public final class ClusterOperationScalingDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ClusterOperationScalingDetails.Builder,ClusterOperationScalingDetails>

The scaling details for a single instance group that is affected by a cluster operation.

See Also:

  • Method Details

    • instanceGroupName

      public final String instanceGroupName()

      The name of the instance group being scaled.

      Returns:
      The name of the instance group being scaled.

    • status

      public final ClusterOperationStatus status()

      The status of the scaling operation for this instance group. Valid values are InProgress, Superseded, or Done.

      If the service returns an enum value that is not available in the current SDK version, status will return ClusterOperationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the scaling operation for this instance group. Valid values are InProgress, Superseded, or Done.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the scaling operation for this instance group. Valid values are InProgress, Superseded, or Done.

      If the service returns an enum value that is not available in the current SDK version, status will return ClusterOperationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the scaling operation for this instance group. Valid values are InProgress, Superseded, or Done.
      See Also:

    • original

      public final ClusterOperationScalingConfiguration original()

      The scaling configuration of the instance group before the scaling operation was applied, including its current, target, and minimum instance counts.

      Returns:
      The scaling configuration of the instance group before the scaling operation was applied, including its current, target, and minimum instance counts.

    • desired

      public final ClusterOperationScalingConfiguration desired()

      The desired scaling configuration of the instance group for the scaling operation, including its target and minimum instance counts.

      Returns:
      The desired scaling configuration of the instance group for the scaling operation, including its target and minimum instance counts.

    • toBuilder

      public ClusterOperationScalingDetails.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<ClusterOperationScalingDetails.Builder,ClusterOperationScalingDetails>
      Returns:
      a builder for type T

    • builder

      public static ClusterOperationScalingDetails.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ClusterOperationScalingDetails.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.

    • sdkFieldNameToField

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