Class ReservedCapacitySummary

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

Details of a reserved capacity for the training plan.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

See Also:

  • Method Details

    • reservedCapacityArn

      public final String reservedCapacityArn()

      The Amazon Resource Name (ARN); of the reserved capacity.

      Returns:
      The Amazon Resource Name (ARN); of the reserved capacity.

    • instanceType

      public final ReservedCapacityInstanceType instanceType()

      The instance type for the reserved capacity.

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

      Returns:
      The instance type for the reserved capacity.
      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      The instance type for the reserved capacity.

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

      Returns:
      The instance type for the reserved capacity.
      See Also:

    • totalInstanceCount

      public final Integer totalInstanceCount()

      The total number of instances in the reserved capacity.

      Returns:
      The total number of instances in the reserved capacity.

    • status

      public final ReservedCapacityStatus status()

      The current status of the reserved capacity.

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

      Returns:
      The current status of the reserved capacity.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the reserved capacity.

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

      Returns:
      The current status of the reserved capacity.
      See Also:

    • availabilityZone

      public final String availabilityZone()

      The availability zone for the reserved capacity.

      Returns:
      The availability zone for the reserved capacity.

    • durationHours

      public final Long durationHours()

      The number of whole hours in the total duration for this reserved capacity.

      Returns:
      The number of whole hours in the total duration for this reserved capacity.

    • durationMinutes

      public final Long durationMinutes()

      The additional minutes beyond whole hours in the total duration for this reserved capacity.

      Returns:
      The additional minutes beyond whole hours in the total duration for this reserved capacity.

    • startTime

      public final Instant startTime()

      The start time of the reserved capacity.

      Returns:
      The start time of the reserved capacity.

    • endTime

      public final Instant endTime()

      The end time of the reserved capacity.

      Returns:
      The end time of the reserved capacity.

    • toBuilder

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

    • builder

      public static ReservedCapacitySummary.Builder builder()

    • serializableBuilderClass

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