Class ProcessingInstancePreference

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

A candidate instance type preference in a processing InstancePreferences list.

See Also:

  • Method Details

    • instanceType

      public final ProcessingInstanceType instanceType()

      The ML compute instance type. An instance type can appear only once in an InstancePreferences list.

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

      Returns:
      The ML compute instance type. An instance type can appear only once in an InstancePreferences list.
      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      The ML compute instance type. An instance type can appear only once in an InstancePreferences list.

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

      Returns:
      The ML compute instance type. An instance type can appear only once in an InstancePreferences list.
      See Also:

    • instanceCount

      public final Integer instanceCount()

      The number of instances to launch if this instance type is selected. Specify the instance count for the processing job in one of the following two ways:

      1. Per preference – Set InstanceCount on every preference in the InstancePreferences list and don't set ProcessingClusterConfig$InstanceCount. Use this when each instance type needs a different number of instances to deliver equivalent compute.

      2. One count for the job – Set ProcessingClusterConfig$InstanceCount and omit it from every preference. Amazon SageMaker applies this to all instance types in the list.

      For example, in a list of five preferences, either all five specify InstanceCount or none of them do. Amazon SageMaker rejects requests that set InstanceCount on only some preferences, that set it both per preference and in ProcessingClusterConfig, or that omit it in both places.

      Returns:
      The number of instances to launch if this instance type is selected. Specify the instance count for the processing job in one of the following two ways:

      1. Per preference – Set InstanceCount on every preference in the InstancePreferences list and don't set ProcessingClusterConfig$InstanceCount. Use this when each instance type needs a different number of instances to deliver equivalent compute.

      2. One count for the job – Set ProcessingClusterConfig$InstanceCount and omit it from every preference. Amazon SageMaker applies this to all instance types in the list.

      For example, in a list of five preferences, either all five specify InstanceCount or none of them do. Amazon SageMaker rejects requests that set InstanceCount on only some preferences, that set it both per preference and in ProcessingClusterConfig, or that omit it in both places.

    • toBuilder

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

    • builder

      public static ProcessingInstancePreference.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.