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

Class DescribeClusterResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

software.amazon.awssdk.services.sagemaker.model.DescribeClusterResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeClusterResponse.Builder,DescribeClusterResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeClusterResponse
extends SageMakerResponse
implements ToCopyableBuilder<DescribeClusterResponse.Builder,DescribeClusterResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeClusterResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeClusterResponse.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 Cluster is created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureMessage()	The failure message of the SageMaker HyperPod cluster.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInstanceGroups()	For responses, this returns true if the service returned a value for the InstanceGroups property.
List<ClusterInstanceGroupDetails>	instanceGroups()	The instance groups of the SageMaker HyperPod cluster.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeClusterResponse.Builder>	serializableBuilderClass()
DescribeClusterResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
VpcConfig	vpcConfig()	Returns the value of the VpcConfig property for this object.

Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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.

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

creationTime

public final Instant creationTime()

The time when the SageMaker Cluster is created.

Returns:

The time when the SageMaker Cluster is created.

failureMessage

public final String failureMessage()

The failure message of the SageMaker HyperPod cluster.

Returns:

The failure message of the SageMaker HyperPod cluster.

hasInstanceGroups

public final boolean hasInstanceGroups()

For responses, this returns true if the service returned a value for the InstanceGroups 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.

instanceGroups

public final List<ClusterInstanceGroupDetails> instanceGroups()

The instance groups of the SageMaker HyperPod cluster.

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 hasInstanceGroups() method.

Returns:

The instance groups of the SageMaker HyperPod cluster.

vpcConfig

public final VpcConfig vpcConfig()

Returns the value of the VpcConfig property for this object.

Returns:

The value of the VpcConfig property for this object.

toBuilder

public DescribeClusterResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeClusterResponse.Builder,DescribeClusterResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeClusterResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeClusterResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo