software.amazon.awssdk.services.sagemaker.model

Class ProductionVariantSummary

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.ProductionVariantSummary

All Implemented Interfaces:

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

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

Describes weight and capacities for a production variant associated with an endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities API and the endpoint status is Updating, you get different desired and current values.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProductionVariantSummary.Builder

Method Summary

Modifier and Type	Method and Description
static ProductionVariantSummary.Builder	builder()
Integer	currentInstanceCount() The number of instances associated with the variant.
Float	currentWeight() The weight associated with the variant.
List<DeployedImage>	deployedImages() An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.
Integer	desiredInstanceCount() The number of instances requested in the UpdateEndpointWeightsAndCapacities request.
Float	desiredWeight() The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDeployedImages() Returns true if the DeployedImages property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ProductionVariantSummary.Builder>	serializableBuilderClass()
ProductionVariantSummary.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	variantName() The name of the variant.

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

variantName

public final String variantName()

The name of the variant.

Returns:

The name of the variant.

hasDeployedImages

public final boolean hasDeployedImages()

Returns true if the DeployedImages property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

deployedImages

public final List<DeployedImage> deployedImages()

An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.

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

You can use hasDeployedImages() to see if a value was sent in this field.

Returns:

An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.

currentWeight

public final Float currentWeight()

The weight associated with the variant.

Returns:

The weight associated with the variant.

desiredWeight

public final Float desiredWeight()

The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.

Returns:

The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.

currentInstanceCount

public final Integer currentInstanceCount()

The number of instances associated with the variant.

Returns:

The number of instances associated with the variant.

desiredInstanceCount

public final Integer desiredInstanceCount()

The number of instances requested in the UpdateEndpointWeightsAndCapacities request.

Returns:

The number of instances requested in the UpdateEndpointWeightsAndCapacities request.

toBuilder

public ProductionVariantSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ProductionVariantSummary.Builder,ProductionVariantSummary>

builder

public static ProductionVariantSummary.Builder builder()

serializableBuilderClass

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