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

Class PendingProductionVariantSummary

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.PendingProductionVariantSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PendingProductionVariantSummary.Builder,PendingProductionVariantSummary>
@Generated("software.amazon.awssdk:codegen") public final class PendingProductionVariantSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PendingProductionVariantSummary.Builder,PendingProductionVariantSummary>

The production variant summary for a deployment when an endpoint is creating or updating with the CreateEndpoint or UpdateEndpoint operations. Describes the VariantStatus , weight and capacity for a production variant associated with an endpoint.

See Also:

  • Method Details

    • 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 for the variant in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

      Returns:
      The requested weight for the variant in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

    • 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 this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

      Returns:
      The number of instances requested in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

    • instanceType

      public final ProductionVariantInstanceType instanceType()

      The type of instances associated with the variant.

      If the service returns an enum value that is not available in the current SDK version, instanceType will return ProductionVariantInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

      Returns:
      The type of instances associated with the variant.
      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      The type of instances associated with the variant.

      If the service returns an enum value that is not available in the current SDK version, instanceType will return ProductionVariantInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

      Returns:
      The type of instances associated with the variant.
      See Also:

    • acceleratorType

      public final ProductionVariantAcceleratorType acceleratorType()

      The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.

      If the service returns an enum value that is not available in the current SDK version, acceleratorType will return ProductionVariantAcceleratorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from acceleratorTypeAsString().

      Returns:
      The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.
      See Also:

    • acceleratorTypeAsString

      public final String acceleratorTypeAsString()

      The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.

      If the service returns an enum value that is not available in the current SDK version, acceleratorType will return ProductionVariantAcceleratorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from acceleratorTypeAsString().

      Returns:
      The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.
      See Also:

    • 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 this deployment, as specified in the endpoint configuration for the endpoint.

      Returns:
      The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.

    • 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 PendingProductionVariantSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PendingProductionVariantSummary.Builder,PendingProductionVariantSummary>
      Returns:
      a builder for type T

    • builder

      public static PendingProductionVariantSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PendingProductionVariantSummary.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.