software.amazon.awssdk.services.sagemaker.model.TrafficRoutingConfig Maven / Gradle / Ivy
Show all versions of sagemaker Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.sagemaker.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Defines the traffic routing strategy during an endpoint deployment to shift traffic from the old fleet to the new
* fleet.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class TrafficRoutingConfig implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Type")
.getter(getter(TrafficRoutingConfig::typeAsString)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Type").build()).build();
private static final SdkField WAIT_INTERVAL_IN_SECONDS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("WaitIntervalInSeconds").getter(getter(TrafficRoutingConfig::waitIntervalInSeconds))
.setter(setter(Builder::waitIntervalInSeconds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("WaitIntervalInSeconds").build())
.build();
private static final SdkField CANARY_SIZE_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("CanarySize").getter(getter(TrafficRoutingConfig::canarySize)).setter(setter(Builder::canarySize))
.constructor(CapacitySize::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CanarySize").build()).build();
private static final SdkField LINEAR_STEP_SIZE_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("LinearStepSize")
.getter(getter(TrafficRoutingConfig::linearStepSize)).setter(setter(Builder::linearStepSize))
.constructor(CapacitySize::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LinearStepSize").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TYPE_FIELD,
WAIT_INTERVAL_IN_SECONDS_FIELD, CANARY_SIZE_FIELD, LINEAR_STEP_SIZE_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final String type;
private final Integer waitIntervalInSeconds;
private final CapacitySize canarySize;
private final CapacitySize linearStepSize;
private TrafficRoutingConfig(BuilderImpl builder) {
this.type = builder.type;
this.waitIntervalInSeconds = builder.waitIntervalInSeconds;
this.canarySize = builder.canarySize;
this.linearStepSize = builder.linearStepSize;
}
/**
*
* 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, {@link #type} will return
* {@link TrafficRoutingConfigType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return 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 TrafficRoutingConfigType
*/
public final TrafficRoutingConfigType type() {
return TrafficRoutingConfigType.fromValue(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, {@link #type} will return
* {@link TrafficRoutingConfigType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return 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 TrafficRoutingConfigType
*/
public final String typeAsString() {
return type;
}
/**
*
* The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.
*
*
* @return The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.
*/
public final Integer waitIntervalInSeconds() {
return waitIntervalInSeconds;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final CapacitySize canarySize() {
return canarySize;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final CapacitySize linearStepSize() {
return linearStepSize;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(typeAsString());
hashCode = 31 * hashCode + Objects.hashCode(waitIntervalInSeconds());
hashCode = 31 * hashCode + Objects.hashCode(canarySize());
hashCode = 31 * hashCode + Objects.hashCode(linearStepSize());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof TrafficRoutingConfig)) {
return false;
}
TrafficRoutingConfig other = (TrafficRoutingConfig) obj;
return Objects.equals(typeAsString(), other.typeAsString())
&& Objects.equals(waitIntervalInSeconds(), other.waitIntervalInSeconds())
&& Objects.equals(canarySize(), other.canarySize()) && Objects.equals(linearStepSize(), other.linearStepSize());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("TrafficRoutingConfig").add("Type", typeAsString())
.add("WaitIntervalInSeconds", waitIntervalInSeconds()).add("CanarySize", canarySize())
.add("LinearStepSize", linearStepSize()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Type":
return Optional.ofNullable(clazz.cast(typeAsString()));
case "WaitIntervalInSeconds":
return Optional.ofNullable(clazz.cast(waitIntervalInSeconds()));
case "CanarySize":
return Optional.ofNullable(clazz.cast(canarySize()));
case "LinearStepSize":
return Optional.ofNullable(clazz.cast(linearStepSize()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("Type", TYPE_FIELD);
map.put("WaitIntervalInSeconds", WAIT_INTERVAL_IN_SECONDS_FIELD);
map.put("CanarySize", CANARY_SIZE_FIELD);
map.put("LinearStepSize", LINEAR_STEP_SIZE_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((TrafficRoutingConfig) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* 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.
*
*
*
*
* @param 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 TrafficRoutingConfigType
* @return Returns a reference to this object so that method calls can be chained together.
* @see TrafficRoutingConfigType
*/
Builder type(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.
*
*
*
*
* @param 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 TrafficRoutingConfigType
* @return Returns a reference to this object so that method calls can be chained together.
* @see TrafficRoutingConfigType
*/
Builder type(TrafficRoutingConfigType type);
/**
*
* The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.
*
*
* @param waitIntervalInSeconds
* The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder waitIntervalInSeconds(Integer waitIntervalInSeconds);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder canarySize(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.
*
* This is a convenience method that creates an instance of the {@link CapacitySize.Builder} avoiding the need
* to create one manually via {@link CapacitySize#builder()}.
*
*
* When the {@link Consumer} completes, {@link CapacitySize.Builder#build()} is called immediately and its
* result is passed to {@link #canarySize(CapacitySize)}.
*
* @param canarySize
* a consumer that will call methods on {@link CapacitySize.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #canarySize(CapacitySize)
*/
default Builder canarySize(Consumer canarySize) {
return canarySize(CapacitySize.builder().applyMutation(canarySize).build());
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder linearStepSize(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.
*
* This is a convenience method that creates an instance of the {@link CapacitySize.Builder} avoiding the need
* to create one manually via {@link CapacitySize#builder()}.
*
*
* When the {@link Consumer} completes, {@link CapacitySize.Builder#build()} is called immediately and its
* result is passed to {@link #linearStepSize(CapacitySize)}.
*
* @param linearStepSize
* a consumer that will call methods on {@link CapacitySize.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #linearStepSize(CapacitySize)
*/
default Builder linearStepSize(Consumer linearStepSize) {
return linearStepSize(CapacitySize.builder().applyMutation(linearStepSize).build());
}
}
static final class BuilderImpl implements Builder {
private String type;
private Integer waitIntervalInSeconds;
private CapacitySize canarySize;
private CapacitySize linearStepSize;
private BuilderImpl() {
}
private BuilderImpl(TrafficRoutingConfig model) {
type(model.type);
waitIntervalInSeconds(model.waitIntervalInSeconds);
canarySize(model.canarySize);
linearStepSize(model.linearStepSize);
}
public final String getType() {
return type;
}
public final void setType(String type) {
this.type = type;
}
@Override
public final Builder type(String type) {
this.type = type;
return this;
}
@Override
public final Builder type(TrafficRoutingConfigType type) {
this.type(type == null ? null : type.toString());
return this;
}
public final Integer getWaitIntervalInSeconds() {
return waitIntervalInSeconds;
}
public final void setWaitIntervalInSeconds(Integer waitIntervalInSeconds) {
this.waitIntervalInSeconds = waitIntervalInSeconds;
}
@Override
public final Builder waitIntervalInSeconds(Integer waitIntervalInSeconds) {
this.waitIntervalInSeconds = waitIntervalInSeconds;
return this;
}
public final CapacitySize.Builder getCanarySize() {
return canarySize != null ? canarySize.toBuilder() : null;
}
public final void setCanarySize(CapacitySize.BuilderImpl canarySize) {
this.canarySize = canarySize != null ? canarySize.build() : null;
}
@Override
public final Builder canarySize(CapacitySize canarySize) {
this.canarySize = canarySize;
return this;
}
public final CapacitySize.Builder getLinearStepSize() {
return linearStepSize != null ? linearStepSize.toBuilder() : null;
}
public final void setLinearStepSize(CapacitySize.BuilderImpl linearStepSize) {
this.linearStepSize = linearStepSize != null ? linearStepSize.build() : null;
}
@Override
public final Builder linearStepSize(CapacitySize linearStepSize) {
this.linearStepSize = linearStepSize;
return this;
}
@Override
public TrafficRoutingConfig build() {
return new TrafficRoutingConfig(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}