TrafficRoutingConfig (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.sagemaker.model

Class TrafficRoutingConfig

java.lang.Object
- com.amazonaws.services.sagemaker.model.TrafficRoutingConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TrafficRoutingConfig
extends Object
implements Serializable, Cloneable, StructuredPojo 
```
Defines the traffic routing strategy during an endpoint deployment to shift traffic from the old fleet to the new fleet.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TrafficRoutingConfig ()

Constructors
Constructor and Description
`TrafficRoutingConfig ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`TrafficRoutingConfig`	`clone ()`
`boolean`	`equals (Object obj)`
`CapacitySize`	`getCanarySize ()` Batch size for the first step to turn on traffic on the new endpoint fleet.
`CapacitySize`	`getLinearStepSize ()` Batch size for each step to turn on traffic on the new endpoint fleet.
`String`	`getType ()` Traffic routing strategy type.
`Integer`	`getWaitIntervalInSeconds ()` The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCanarySize (CapacitySize canarySize)` Batch size for the first step to turn on traffic on the new endpoint fleet.
`void`	`setLinearStepSize (CapacitySize linearStepSize)` Batch size for each step to turn on traffic on the new endpoint fleet.
`void`	`setType (String type)` Traffic routing strategy type.
`void`	`setWaitIntervalInSeconds (Integer waitIntervalInSeconds)` The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.
`String`	`toString ()` Returns a string representation of this object.
`TrafficRoutingConfig`	`withCanarySize (CapacitySize canarySize)` Batch size for the first step to turn on traffic on the new endpoint fleet.
`TrafficRoutingConfig`	`withLinearStepSize (CapacitySize linearStepSize)` Batch size for each step to turn on traffic on the new endpoint fleet.
`TrafficRoutingConfig`	`withType (String type)` Traffic routing strategy type.
`TrafficRoutingConfig`	`withType (TrafficRoutingConfigType type)` Traffic routing strategy type.
`TrafficRoutingConfig`	`withWaitIntervalInSeconds (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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TrafficRoutingConfig
```
public TrafficRoutingConfig()
```
- Method Detail
  - setType
```
public void setType(String 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.
    Parameters:
    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.
    See Also:
    
    TrafficRoutingConfigType
  - getType
```
public String getType()
```
    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.
    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
  - withType
```
public TrafficRoutingConfig withType(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TrafficRoutingConfigType
  - withType
```
public TrafficRoutingConfig withType(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TrafficRoutingConfigType
  - setWaitIntervalInSeconds
```
public void setWaitIntervalInSeconds(Integer waitIntervalInSeconds)
```
    The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.
    
    Parameters:
    
    waitIntervalInSeconds - The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.
  - getWaitIntervalInSeconds
```
public Integer getWaitIntervalInSeconds()
```
    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.
  - withWaitIntervalInSeconds
```
public TrafficRoutingConfig withWaitIntervalInSeconds(Integer waitIntervalInSeconds)
```
    The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.
    
    Parameters:
    
    waitIntervalInSeconds - The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCanarySize
```
public void setCanarySize(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.
    
    Parameters:
    
    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.
  - getCanarySize
```
public CapacitySize getCanarySize()
```
    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.
  - withCanarySize
```
public TrafficRoutingConfig withCanarySize(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLinearStepSize
```
public void setLinearStepSize(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.
    
    Parameters:
    
    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.
  - getLinearStepSize
```
public CapacitySize getLinearStepSize()
```
    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.
  - withLinearStepSize
```
public TrafficRoutingConfig withLinearStepSize(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public TrafficRoutingConfig clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class TrafficRoutingConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TrafficRoutingConfig

Method Detail

setType

getType

withType

withType

setWaitIntervalInSeconds

getWaitIntervalInSeconds

withWaitIntervalInSeconds

setCanarySize

getCanarySize

withCanarySize

setLinearStepSize

getLinearStepSize

withLinearStepSize

toString

equals

hashCode

clone

marshall