Class CapacityReservationSummary

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.CapacityReservationSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CapacityReservationSummary.Builder,CapacityReservationSummary>

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

Summary information about a SageMaker Capacity Reservation.

See Also:
  • Method Details

    • smCapacityReservationArn

      public final String smCapacityReservationArn()

      The Amazon Resource Name (ARN) of the SageMaker Capacity Reservation.

      Returns:
      The Amazon Resource Name (ARN) of the SageMaker Capacity Reservation.
    • smCapacityReservationId

      public final String smCapacityReservationId()

      The ID of the SageMaker Capacity Reservation. The ID is the last part of the ARN and starts with smcr-.

      Returns:
      The ID of the SageMaker Capacity Reservation. The ID is the last part of the ARN and starts with smcr-.
    • owner

      public final String owner()

      The ID of the Amazon Web Services account that owns the SageMaker Capacity Reservation.

      Returns:
      The ID of the Amazon Web Services account that owns the SageMaker Capacity Reservation.
    • status

      public final CapacityReservationStatus status()

      The status of the SageMaker Capacity Reservation. SageMaker AI sets the status from the start and end times of the reservation. Valid values:

      Scheduled

      The current time is before StartTime.

      Active

      The current time is between StartTime and EndTime. You can use the reserved instances.

      Expired

      The current time is at or after EndTime.

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

      Returns:
      The status of the SageMaker Capacity Reservation. SageMaker AI sets the status from the start and end times of the reservation. Valid values:

      Scheduled

      The current time is before StartTime.

      Active

      The current time is between StartTime and EndTime. You can use the reserved instances.

      Expired

      The current time is at or after EndTime.

      See Also:
    • statusAsString

      public final String statusAsString()

      The status of the SageMaker Capacity Reservation. SageMaker AI sets the status from the start and end times of the reservation. Valid values:

      Scheduled

      The current time is before StartTime.

      Active

      The current time is between StartTime and EndTime. You can use the reserved instances.

      Expired

      The current time is at or after EndTime.

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

      Returns:
      The status of the SageMaker Capacity Reservation. SageMaker AI sets the status from the start and end times of the reservation. Valid values:

      Scheduled

      The current time is before StartTime.

      Active

      The current time is between StartTime and EndTime. You can use the reserved instances.

      Expired

      The current time is at or after EndTime.

      See Also:
    • instanceType

      public final String instanceType()

      The SageMaker AI instance type of the reserved instances, for example ml.p5.48xlarge.

      Returns:
      The SageMaker AI instance type of the reserved instances, for example ml.p5.48xlarge.
    • availabilityZone

      public final String availabilityZone()

      The name of the Availability Zone of the reserved instances, for example us-east-1a. Availability Zone names can map to different physical zones in different accounts. To identify the same zone across accounts, use AvailabilityZoneId.

      Returns:
      The name of the Availability Zone of the reserved instances, for example us-east-1a. Availability Zone names can map to different physical zones in different accounts. To identify the same zone across accounts, use AvailabilityZoneId.
    • availabilityZoneId

      public final String availabilityZoneId()

      The ID of the Availability Zone of the reserved instances, for example use1-az1. An Availability Zone ID identifies the same physical zone in every account.

      Returns:
      The ID of the Availability Zone of the reserved instances, for example use1-az1. An Availability Zone ID identifies the same physical zone in every account.
    • totalInstanceCount

      public final Integer totalInstanceCount()

      The number of instances in the SageMaker Capacity Reservation.

      Returns:
      The number of instances in the SageMaker Capacity Reservation.
    • startTime

      public final Instant startTime()

      The time when the reserved instances become available.

      Returns:
      The time when the reserved instances become available.
    • endTime

      public final Instant endTime()

      The time when the SageMaker Capacity Reservation ends. This value is not returned if the reservation has no end time.

      Returns:
      The time when the SageMaker Capacity Reservation ends. This value is not returned if the reservation has no end time.
    • creationTime

      public final Instant creationTime()

      The time when the SageMaker Capacity Reservation was created.

      Returns:
      The time when the SageMaker Capacity Reservation was created.
    • 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<CapacityReservationSummary.Builder,CapacityReservationSummary>
      Returns:
      a builder for type T
    • builder

      public static CapacityReservationSummary.Builder builder()
    • serializableBuilderClass

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