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

Class ClusterSummary

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.ClusterSummary

All Implemented Interfaces:

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

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

Lists a summary of the properties of a SageMaker HyperPod cluster.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ClusterSummary.Builder

Method Summary

Modifier and Type	Method	Description
static ClusterSummary.Builder	builder()
String	clusterArn()	The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.
String	clusterName()	The name of the SageMaker HyperPod cluster.
ClusterStatus	clusterStatus()	The status of the SageMaker HyperPod cluster.
String	clusterStatusAsString()	The status of the SageMaker HyperPod cluster.
Instant	creationTime()	The time when the SageMaker HyperPod cluster is created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTrainingPlanArns()	For responses, this returns true if the service returned a value for the TrainingPlanArns property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ClusterSummary.Builder>	serializableBuilderClass()
ClusterSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	trainingPlanArns()	A list of Amazon Resource Names (ARNs) of the training plans associated with this cluster.

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

clusterArn

public final String clusterArn()

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

Returns:

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

clusterName

public final String clusterName()

The name of the SageMaker HyperPod cluster.

Returns:

The name of the SageMaker HyperPod cluster.

creationTime

public final Instant creationTime()

The time when the SageMaker HyperPod cluster is created.

Returns:

The time when the SageMaker HyperPod cluster is created.

clusterStatus

public final ClusterStatus clusterStatus()

The status of the SageMaker HyperPod cluster.

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

Returns:

The status of the SageMaker HyperPod cluster.

See Also:

ClusterStatus

clusterStatusAsString

public final String clusterStatusAsString()

The status of the SageMaker HyperPod cluster.

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

Returns:

The status of the SageMaker HyperPod cluster.

See Also:

ClusterStatus

hasTrainingPlanArns

public final boolean hasTrainingPlanArns()

For responses, this returns true if the service returned a value for the TrainingPlanArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

trainingPlanArns

public final List<String> trainingPlanArns()

A list of Amazon Resource Names (ARNs) of the training plans associated with this cluster.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTrainingPlanArns() method.

Returns:

A list of Amazon Resource Names (ARNs) of the training plans associated with this cluster.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

toBuilder

public ClusterSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ClusterSummary.Builder,ClusterSummary>

builder

public static ClusterSummary.Builder builder()

serializableBuilderClass

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