Class InferenceComponentCapacitySize

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

Specifies the type and size of the endpoint capacity to activate for a rolling deployment or a rollback strategy. You can specify your batches as either of the following:

  • A count of inference component copies

  • The overall percentage or your fleet

For a rollback strategy, if you don't specify the fields in this object, or if you set the Value parameter to 100%, then SageMaker AI uses a blue/green rollback strategy and rolls all traffic back to the blue fleet.

See Also:

  • Method Details

    • type

      public final InferenceComponentCapacitySizeType type()

      Specifies the endpoint capacity type.

      COPY_COUNT

      The endpoint activates based on the number of inference component copies.

      CAPACITY_PERCENT

      The endpoint activates based on the specified percentage of capacity.

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

      Returns:
      Specifies the endpoint capacity type.

      COPY_COUNT

      The endpoint activates based on the number of inference component copies.

      CAPACITY_PERCENT

      The endpoint activates based on the specified percentage of capacity.

      See Also:

    • typeAsString

      public final String typeAsString()

      Specifies the endpoint capacity type.

      COPY_COUNT

      The endpoint activates based on the number of inference component copies.

      CAPACITY_PERCENT

      The endpoint activates based on the specified percentage of capacity.

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

      Returns:
      Specifies the endpoint capacity type.

      COPY_COUNT

      The endpoint activates based on the number of inference component copies.

      CAPACITY_PERCENT

      The endpoint activates based on the specified percentage of capacity.

      See Also:

    • value

      public final Integer value()

      Defines the capacity size, either as a number of inference component copies or a capacity percentage.

      Returns:
      Defines the capacity size, either as a number of inference component copies or a capacity percentage.

    • toBuilder

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

    • builder

      public static InferenceComponentCapacitySize.Builder builder()

    • serializableBuilderClass

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