Class TrafficRoutingConfig

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

Defines the traffic routing strategy during an endpoint deployment to shift traffic from the old fleet to the new fleet.

See Also:

  • Method Details

    • type

      public final TrafficRoutingConfigType type()

      Traffic routing strategy type.

      • ALL_AT_ONCE: Endpoint traffic shifts to the new fleet in a single step.

      • CANARY: Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic.

      • LINEAR: Endpoint traffic shifts to the new fleet in n steps of a configurable size.

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

      Returns:
      Traffic routing strategy type.

      • ALL_AT_ONCE: Endpoint traffic shifts to the new fleet in a single step.

      • CANARY: Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic.

      • LINEAR: Endpoint traffic shifts to the new fleet in n steps of a configurable size.

      See Also:

    • typeAsString

      public final String typeAsString()

      Traffic routing strategy type.

      • ALL_AT_ONCE: Endpoint traffic shifts to the new fleet in a single step.

      • CANARY: Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic.

      • LINEAR: Endpoint traffic shifts to the new fleet in n steps of a configurable size.

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

      Returns:
      Traffic routing strategy type.

      • ALL_AT_ONCE: Endpoint traffic shifts to the new fleet in a single step.

      • CANARY: Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic.

      • LINEAR: Endpoint traffic shifts to the new fleet in n steps of a configurable size.

      See Also:

    • waitIntervalInSeconds

      public final Integer waitIntervalInSeconds()

      The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.

      Returns:
      The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.

    • canarySize

      public final CapacitySize canarySize()

      Batch size for the first step to turn on traffic on the new endpoint fleet. Value must be less than or equal to 50% of the variant's total instance count.

      Returns:
      Batch size for the first step to turn on traffic on the new endpoint fleet. Value must be less than or equal to 50% of the variant's total instance count.

    • linearStepSize

      public final CapacitySize linearStepSize()

      Batch size for each step to turn on traffic on the new endpoint fleet. Value must be 10-50% of the variant's total instance count.

      Returns:
      Batch size for each step to turn on traffic on the new endpoint fleet. Value must be 10-50% of the variant's total instance count.

    • toBuilder

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

    • builder

      public static TrafficRoutingConfig.Builder builder()

    • serializableBuilderClass

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