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

Class CapacitySize

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

Specifies the type and size of the endpoint capacity to activate for a blue/green deployment, a rolling deployment, or a rollback strategy. You can specify your batches as either instance count or 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 to 100%, then SageMaker uses a blue/green rollback strategy and rolls all traffic back to the blue fleet.

See Also:

  • Method Details

    • type

      public final CapacitySizeType type()

      Specifies the endpoint capacity type.

      • INSTANCE_COUNT: The endpoint activates based on the number of instances.

      • 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 CapacitySizeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      Specifies the endpoint capacity type.

      • INSTANCE_COUNT: The endpoint activates based on the number of instances.

      • CAPACITY_PERCENT: The endpoint activates based on the specified percentage of capacity.

      See Also:

    • typeAsString

      public final String typeAsString()

      Specifies the endpoint capacity type.

      • INSTANCE_COUNT: The endpoint activates based on the number of instances.

      • 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 CapacitySizeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      Specifies the endpoint capacity type.

      • INSTANCE_COUNT: The endpoint activates based on the number of instances.

      • 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 instances or a capacity percentage.

      Returns:
      Defines the capacity size, either as a number of instances or a capacity percentage.

    • toBuilder

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

    • builder

      public static CapacitySize.Builder builder()

    • serializableBuilderClass

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