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

Class ClusterNodeSummary

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.ClusterNodeSummary

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class ClusterNodeSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ClusterNodeSummary.Builder,ClusterNodeSummary>

Lists a summary of the properties of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ClusterNodeSummary.Builder

Method Summary

Modifier and Type	Method	Description
static ClusterNodeSummary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	instanceGroupName()	The name of the instance group in which the instance is.
String	instanceId()	The ID of the instance.
ClusterInstanceStatusDetails	instanceStatus()	The status of the instance.
ClusterInstanceType	instanceType()	The type of the instance.
String	instanceTypeAsString()	The type of the instance.
Instant	lastSoftwareUpdateTime()	The time when SageMaker last updated the software of the instances in the cluster.
Instant	launchTime()	The time when the instance is launched.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ClusterNodeSummary.Builder>	serializableBuilderClass()
ClusterNodeSummary.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

instanceGroupName

public final String instanceGroupName()

The name of the instance group in which the instance is.

Returns:

The name of the instance group in which the instance is.

instanceId

public final String instanceId()

The ID of the instance.

Returns:

The ID of the instance.

instanceType

public final ClusterInstanceType instanceType()

The type of the instance.

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

Returns:

The type of the instance.

See Also:

ClusterInstanceType

instanceTypeAsString

public final String instanceTypeAsString()

The type of the instance.

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

Returns:

The type of the instance.

See Also:

ClusterInstanceType

launchTime

public final Instant launchTime()

The time when the instance is launched.

Returns:

The time when the instance is launched.

lastSoftwareUpdateTime

public final Instant lastSoftwareUpdateTime()

The time when SageMaker last updated the software of the instances in the cluster.

Returns:

The time when SageMaker last updated the software of the instances in the cluster.

instanceStatus

public final ClusterInstanceStatusDetails instanceStatus()

The status of the instance.

Returns:

The status of the instance.

toBuilder

public ClusterNodeSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ClusterNodeSummary.Builder,ClusterNodeSummary>

builder

public static ClusterNodeSummary.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo