Class ProductionVariantCapacityReservationSummary

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

Details about an ML capacity reservation.

See Also:

  • Method Details

    • mlReservationArn

      public final String mlReservationArn()

      The Amazon Resource Name (ARN) that uniquely identifies the ML capacity reservation that SageMaker AI applies when it deploys the endpoint.

      Returns:
      The Amazon Resource Name (ARN) that uniquely identifies the ML capacity reservation that SageMaker AI applies when it deploys the endpoint.

    • capacityReservationPreference

      public final CapacityReservationPreference capacityReservationPreference()

      The option that you chose for the capacity reservation. SageMaker AI supports the following options:

      capacity-reservations-only

      SageMaker AI launches instances only into an ML capacity reservation. If no capacity is available, the instances fail to launch.

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

      Returns:
      The option that you chose for the capacity reservation. SageMaker AI supports the following options:

      capacity-reservations-only

      SageMaker AI launches instances only into an ML capacity reservation. If no capacity is available, the instances fail to launch.

      See Also:

    • capacityReservationPreferenceAsString

      public final String capacityReservationPreferenceAsString()

      The option that you chose for the capacity reservation. SageMaker AI supports the following options:

      capacity-reservations-only

      SageMaker AI launches instances only into an ML capacity reservation. If no capacity is available, the instances fail to launch.

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

      Returns:
      The option that you chose for the capacity reservation. SageMaker AI supports the following options:

      capacity-reservations-only

      SageMaker AI launches instances only into an ML capacity reservation. If no capacity is available, the instances fail to launch.

      See Also:

    • totalInstanceCount

      public final Integer totalInstanceCount()

      The number of instances that you allocated to the ML capacity reservation.

      Returns:
      The number of instances that you allocated to the ML capacity reservation.

    • availableInstanceCount

      public final Integer availableInstanceCount()

      The number of instances that are currently available in the ML capacity reservation.

      Returns:
      The number of instances that are currently available in the ML capacity reservation.

    • usedByCurrentEndpoint

      public final Integer usedByCurrentEndpoint()

      The number of instances from the ML capacity reservation that are being used by the endpoint.

      Returns:
      The number of instances from the ML capacity reservation that are being used by the endpoint.

    • hasEc2CapacityReservations

      public final boolean hasEc2CapacityReservations()
      For responses, this returns true if the service returned a value for the Ec2CapacityReservations 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.

    • ec2CapacityReservations

      public final List<Ec2CapacityReservation> ec2CapacityReservations()

      The EC2 capacity reservations that are shared to this ML capacity reservation, if any.

      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 hasEc2CapacityReservations() method.

      Returns:
      The EC2 capacity reservations that are shared to this ML capacity reservation, if any.

    • toBuilder

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

    • builder

      public static ProductionVariantCapacityReservationSummary.Builder builder()

    • serializableBuilderClass

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