Package software.amazon.awssdk.services.sagemaker.model

Class ProductionVariantCapacityReservationSummary

    • Method Detail

      • 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:
        CapacityReservationPreference

      • 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:
        CapacityReservationPreference

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

      • hashCode

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

      • equals

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

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