ProductionVariantSummary (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ProductionVariantSummary
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ProductionVariantSummary()

Constructors
Constructor and Description
`ProductionVariantSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProductionVariantSummary`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getCurrentInstanceCount()` The number of instances associated with the variant.
`Float`	`getCurrentWeight()` The weight associated with the variant.
`List<DeployedImage>`	`getDeployedImages()` An array of `DeployedImage` objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this `ProductionVariant`.
`Integer`	`getDesiredInstanceCount()` The number of instances requested in the `UpdateEndpointWeightsAndCapacities` request.
`Float`	`getDesiredWeight()` The requested weight, as specified in the `UpdateEndpointWeightsAndCapacities` request.
`String`	`getVariantName()` The name of the variant.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCurrentInstanceCount(Integer currentInstanceCount)` The number of instances associated with the variant.
`void`	`setCurrentWeight(Float currentWeight)` The weight associated with the variant.
`void`	`setDeployedImages(Collection<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`.
`void`	`setDesiredInstanceCount(Integer desiredInstanceCount)` The number of instances requested in the `UpdateEndpointWeightsAndCapacities` request.
`void`	`setDesiredWeight(Float desiredWeight)` The requested weight, as specified in the `UpdateEndpointWeightsAndCapacities` request.
`void`	`setVariantName(String variantName)` The name of the variant.
`String`	`toString()` Returns a string representation of this object.
`ProductionVariantSummary`	`withCurrentInstanceCount(Integer currentInstanceCount)` The number of instances associated with the variant.
`ProductionVariantSummary`	`withCurrentWeight(Float currentWeight)` The weight associated with the variant.
`ProductionVariantSummary`	`withDeployedImages(Collection<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`.
`ProductionVariantSummary`	`withDeployedImages(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`.
`ProductionVariantSummary`	`withDesiredInstanceCount(Integer desiredInstanceCount)` The number of instances requested in the `UpdateEndpointWeightsAndCapacities` request.
`ProductionVariantSummary`	`withDesiredWeight(Float desiredWeight)` The requested weight, as specified in the `UpdateEndpointWeightsAndCapacities` request.
`ProductionVariantSummary`	`withVariantName(String variantName)` The name of the variant.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ProductionVariantSummary
```
public ProductionVariantSummary()
```
- Method Detail
  - setVariantName
```
public void setVariantName(String variantName)
```
    The name of the variant.
    
    Parameters:
    
    variantName - The name of the variant.
  - getVariantName
```
public String getVariantName()
```
    The name of the variant.
    
    Returns:
    
    The name of the variant.
  - withVariantName
```
public ProductionVariantSummary withVariantName(String variantName)
```
    The name of the variant.
    
    Parameters:
    
    variantName - The name of the variant.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDeployedImages
```
public List<DeployedImage> getDeployedImages()
```
    An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.
    
    Returns:
    
    An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.
  - setDeployedImages
```
public void setDeployedImages(Collection<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.
    
    Parameters:
    
    deployedImages - An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.
  - withDeployedImages
```
public ProductionVariantSummary withDeployedImages(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setDeployedImages(java.util.Collection) or withDeployedImages(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    deployedImages - An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDeployedImages
```
public ProductionVariantSummary withDeployedImages(Collection<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.
    
    Parameters:
    
    deployedImages - An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCurrentWeight
```
public void setCurrentWeight(Float currentWeight)
```
    The weight associated with the variant.
    
    Parameters:
    
    currentWeight - The weight associated with the variant.
  - getCurrentWeight
```
public Float getCurrentWeight()
```
    The weight associated with the variant.
    
    Returns:
    
    The weight associated with the variant.
  - withCurrentWeight
```
public ProductionVariantSummary withCurrentWeight(Float currentWeight)
```
    The weight associated with the variant.
    
    Parameters:
    
    currentWeight - The weight associated with the variant.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDesiredWeight
```
public void setDesiredWeight(Float desiredWeight)
```
    The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.
    
    Parameters:
    
    desiredWeight - The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.
  - getDesiredWeight
```
public Float getDesiredWeight()
```
    The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.
    
    Returns:
    
    The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.
  - withDesiredWeight
```
public ProductionVariantSummary withDesiredWeight(Float desiredWeight)
```
    The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.
    
    Parameters:
    
    desiredWeight - The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCurrentInstanceCount
```
public void setCurrentInstanceCount(Integer currentInstanceCount)
```
    The number of instances associated with the variant.
    
    Parameters:
    
    currentInstanceCount - The number of instances associated with the variant.
  - getCurrentInstanceCount
```
public Integer getCurrentInstanceCount()
```
    The number of instances associated with the variant.
    
    Returns:
    
    The number of instances associated with the variant.
  - withCurrentInstanceCount
```
public ProductionVariantSummary withCurrentInstanceCount(Integer currentInstanceCount)
```
    The number of instances associated with the variant.
    
    Parameters:
    
    currentInstanceCount - The number of instances associated with the variant.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDesiredInstanceCount
```
public void setDesiredInstanceCount(Integer desiredInstanceCount)
```
    The number of instances requested in the UpdateEndpointWeightsAndCapacities request.
    
    Parameters:
    
    desiredInstanceCount - The number of instances requested in the UpdateEndpointWeightsAndCapacities request.
  - getDesiredInstanceCount
```
public Integer getDesiredInstanceCount()
```
    The number of instances requested in the UpdateEndpointWeightsAndCapacities request.
    
    Returns:
    
    The number of instances requested in the UpdateEndpointWeightsAndCapacities request.
  - withDesiredInstanceCount
```
public ProductionVariantSummary withDesiredInstanceCount(Integer desiredInstanceCount)
```
    The number of instances requested in the UpdateEndpointWeightsAndCapacities request.
    
    Parameters:
    
    desiredInstanceCount - The number of instances requested in the UpdateEndpointWeightsAndCapacities request.
    
    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 ProductionVariantSummary 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.

Did this page help you?

Class ProductionVariantSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProductionVariantSummary

Method Detail

setVariantName

getVariantName

withVariantName

getDeployedImages

setDeployedImages

withDeployedImages

withDeployedImages

setCurrentWeight

getCurrentWeight

withCurrentWeight

setDesiredWeight

getDesiredWeight

withDesiredWeight

setCurrentInstanceCount

getCurrentInstanceCount

withCurrentInstanceCount

setDesiredInstanceCount

getDesiredInstanceCount

withDesiredInstanceCount

toString

equals

hashCode

clone

marshall