java.lang.Object
- software.amazon.awssdk.services.sagemaker.model.ProductionVariantSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ProductionVariantSummary.Builder,ProductionVariantSummary>
```
@Generated("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 Description

static interface ProductionVariantSummary.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ProductionVariantSummary.Builder`	`builder()`
`Integer`	`currentInstanceCount()`	The number of instances associated with the variant.
`ProductionVariantServerlessConfig`	`currentServerlessConfig()`	The serverless configuration for the endpoint.
`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.
`ProductionVariantServerlessConfig`	`desiredServerlessConfig()`	The serverless configuration requested for the endpoint update.
`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()`	For responses, this returns true if the service returned a value for the DeployedImages property.
`int`	`hashCode()`
`boolean`	`hasVariantStatus()`	For responses, this returns true if the service returned a value for the VariantStatus property.
`ProductionVariantManagedInstanceScaling`	`managedInstanceScaling()`	Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.
`ProductionVariantRoutingConfig`	`routingConfig()`	Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`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.
`List<ProductionVariantStatus>`	`variantStatus()`	The endpoint variant status which describes the current deployment stage status or operational status.

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()
```
    For responses, this returns true if the service returned a value for the DeployedImages 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.
  - 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.
    
    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 hasDeployedImages() method.
    
    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.
  - hasVariantStatus
```
public final boolean hasVariantStatus()
```
    For responses, this returns true if the service returned a value for the VariantStatus 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.
  - variantStatus
```
public final List<ProductionVariantStatus> variantStatus()
```
    The endpoint variant status which describes the current deployment stage status or operational status.
    
    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 hasVariantStatus() method.
    
    Returns:
    
    The endpoint variant status which describes the current deployment stage status or operational status.
  - currentServerlessConfig
```
public final ProductionVariantServerlessConfig currentServerlessConfig()
```
    The serverless configuration for the endpoint.
    
    Returns:
    
    The serverless configuration for the endpoint.
  - desiredServerlessConfig
```
public final ProductionVariantServerlessConfig desiredServerlessConfig()
```
    The serverless configuration requested for the endpoint update.
    
    Returns:
    
    The serverless configuration requested for the endpoint update.
  - managedInstanceScaling
```
public final ProductionVariantManagedInstanceScaling managedInstanceScaling()
```
    Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.
    
    Returns:
    
    Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.
  - routingConfig
```
public final ProductionVariantRoutingConfig routingConfig()
```
    Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.
    
    Returns:
    
    Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class ProductionVariantSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

variantName

hasDeployedImages

deployedImages

currentWeight

desiredWeight

currentInstanceCount

desiredInstanceCount

hasVariantStatus

variantStatus

currentServerlessConfig

desiredServerlessConfig

managedInstanceScaling

routingConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField