Class InstanceGroup

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

Defines an instance group for heterogeneous cluster training. When requesting a training job using the CreateTrainingJob API, you can configure multiple instance groups .

See Also:

  • Method Details

    • instanceType

      public final TrainingInstanceType instanceType()

      Specifies the instance type of the instance group.

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

      Returns:
      Specifies the instance type of the instance group.
      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      Specifies the instance type of the instance group.

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

      Returns:
      Specifies the instance type of the instance group.
      See Also:

    • instanceCount

      public final Integer instanceCount()

      Specifies the number of instances of the instance group.

      Returns:
      Specifies the number of instances of the instance group.

    • instanceGroupName

      public final String instanceGroupName()

      Specifies the name of the instance group.

      Returns:
      Specifies the name of the instance group.

    • toBuilder

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

    • builder

      public static InstanceGroup.Builder builder()

    • serializableBuilderClass

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