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

Class ShadowModeConfig

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.ShadowModeConfig

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class ShadowModeConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ShadowModeConfig.Builder,ShadowModeConfig>

The configuration of ShadowMode inference experiment type, which specifies a production variant to take all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also specifies the percentage of requests that Amazon SageMaker replicates.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ShadowModeConfig.Builder

Method Summary

Modifier and Type	Method	Description
static ShadowModeConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasShadowModelVariants()	For responses, this returns true if the service returned a value for the ShadowModelVariants property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ShadowModeConfig.Builder>	serializableBuilderClass()
List<ShadowModelVariantConfig>	shadowModelVariants()	List of shadow variant configurations.
String	sourceModelVariantName()	The name of the production variant, which takes all the inference requests.
ShadowModeConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

sourceModelVariantName

public final String sourceModelVariantName()

The name of the production variant, which takes all the inference requests.

Returns:

The name of the production variant, which takes all the inference requests.

hasShadowModelVariants

public final boolean hasShadowModelVariants()

For responses, this returns true if the service returned a value for the ShadowModelVariants property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

shadowModelVariants

public final List<ShadowModelVariantConfig> shadowModelVariants()

List of shadow variant configurations.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasShadowModelVariants() method.

Returns:

List of shadow variant configurations.

toBuilder

public ShadowModeConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ShadowModeConfig.Builder,ShadowModeConfig>

builder

public static ShadowModeConfig.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo