software.amazon.awssdk.services.sagemaker.model

Class InstanceGroup

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.InstanceGroup

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InstanceGroup.Builder,InstanceGroup>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InstanceGroup.Builder

Method Summary

Modifier and Type	Method and Description
static InstanceGroup.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	instanceCount() Specifies the number of instances of the instance group.
String	instanceGroupName() Specifies the name of the instance group.
TrainingInstanceType	instanceType() Specifies the instance type of the instance group.
String	instanceTypeAsString() Specifies the instance type of the instance group.
List<SdkField<?>>	sdkFields()
static Class<? extends InstanceGroup.Builder>	serializableBuilderClass()
InstanceGroup.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

TrainingInstanceType

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:

TrainingInstanceType

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()

Specified by:

toBuilder in interface ToCopyableBuilder<InstanceGroup.Builder,InstanceGroup>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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