software.amazon.awssdk.services.sagemaker.model

Class TrafficRoutingConfig

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.TrafficRoutingConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TrafficRoutingConfig.Builder,TrafficRoutingConfig>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TrafficRoutingConfig.Builder

Method Summary

Modifier and Type	Method and Description
static TrafficRoutingConfig.Builder	builder()
CapacitySize	canarySize() Batch size for the first step to turn on traffic on the new endpoint fleet.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
CapacitySize	linearStepSize() Batch size for each step to turn on traffic on the new endpoint fleet.
List<SdkField<?>>	sdkFields()
static Class<? extends TrafficRoutingConfig.Builder>	serializableBuilderClass()
TrafficRoutingConfig.Builder	toBuilder()
String	toString() Returns a string representation of this object.
TrafficRoutingConfigType	type() Traffic routing strategy type.
String	typeAsString() Traffic routing strategy type.
Integer	waitIntervalInSeconds() The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

TrafficRoutingConfigType

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:

TrafficRoutingConfigType

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

Specified by:

toBuilder in interface ToCopyableBuilder<TrafficRoutingConfig.Builder,TrafficRoutingConfig>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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