Class VariantProperty

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

Specifies a production variant property type for an Endpoint.

If you are updating an endpoint with the RetainAllVariantProperties option of UpdateEndpointInput set to true, the VariantProperty objects listed in the ExcludeRetainedVariantProperties parameter of UpdateEndpointInput override the existing variant properties of the endpoint.

See Also:

  • Method Details

    • variantPropertyType

      public final VariantPropertyType variantPropertyType()

      The type of variant property. The supported values are:

      • DesiredInstanceCount: Overrides the existing variant instance counts using the InitialInstanceCount values in the ProductionVariants of CreateEndpointConfig.

      • DesiredWeight: Overrides the existing variant weights using the InitialVariantWeight values in the ProductionVariants of CreateEndpointConfig.

      • DataCaptureConfig: (Not currently supported.)

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

      Returns:
      The type of variant property. The supported values are:

      • DesiredInstanceCount: Overrides the existing variant instance counts using the InitialInstanceCount values in the ProductionVariants of CreateEndpointConfig.

      • DesiredWeight: Overrides the existing variant weights using the InitialVariantWeight values in the ProductionVariants of CreateEndpointConfig.

      • DataCaptureConfig: (Not currently supported.)

      See Also:

    • variantPropertyTypeAsString

      public final String variantPropertyTypeAsString()

      The type of variant property. The supported values are:

      • DesiredInstanceCount: Overrides the existing variant instance counts using the InitialInstanceCount values in the ProductionVariants of CreateEndpointConfig.

      • DesiredWeight: Overrides the existing variant weights using the InitialVariantWeight values in the ProductionVariants of CreateEndpointConfig.

      • DataCaptureConfig: (Not currently supported.)

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

      Returns:
      The type of variant property. The supported values are:

      • DesiredInstanceCount: Overrides the existing variant instance counts using the InitialInstanceCount values in the ProductionVariants of CreateEndpointConfig.

      • DesiredWeight: Overrides the existing variant weights using the InitialVariantWeight values in the ProductionVariants of CreateEndpointConfig.

      • DataCaptureConfig: (Not currently supported.)

      See Also:

    • toBuilder

      public VariantProperty.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<VariantProperty.Builder,VariantProperty>
      Returns:
      a builder for type T

    • builder

      public static VariantProperty.Builder builder()

    • serializableBuilderClass

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