Interface DescribeClusterResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeClusterResponse.Builder,DescribeClusterResponse>, SageMakerResponse.Builder, SdkBuilder<DescribeClusterResponse.Builder,DescribeClusterResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeClusterResponse

public static interface DescribeClusterResponse.Builder
extends SageMakerResponse.Builder, SdkPojo, CopyableBuilder<DescribeClusterResponse.Builder,DescribeClusterResponse>

Method Summary

Modifier and Type	Method	Description
DescribeClusterResponse.Builder	clusterArn(String clusterArn)	The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.
DescribeClusterResponse.Builder	clusterName(String clusterName)	The name of the SageMaker HyperPod cluster.
DescribeClusterResponse.Builder	clusterStatus(String clusterStatus)	The status of the SageMaker HyperPod cluster.
DescribeClusterResponse.Builder	clusterStatus(ClusterStatus clusterStatus)	The status of the SageMaker HyperPod cluster.
DescribeClusterResponse.Builder	creationTime(Instant creationTime)	The time when the SageMaker Cluster is created.
DescribeClusterResponse.Builder	failureMessage(String failureMessage)	The failure message of the SageMaker HyperPod cluster.
DescribeClusterResponse.Builder	instanceGroups(Collection<ClusterInstanceGroupDetails> instanceGroups)	The instance groups of the SageMaker HyperPod cluster.
DescribeClusterResponse.Builder	instanceGroups(Consumer<ClusterInstanceGroupDetails.Builder>... instanceGroups)	The instance groups of the SageMaker HyperPod cluster.
DescribeClusterResponse.Builder	instanceGroups(ClusterInstanceGroupDetails... instanceGroups)	The instance groups of the SageMaker HyperPod cluster.
DescribeClusterResponse.Builder	nodeRecovery(String nodeRecovery)	The node recovery mode configured for the SageMaker HyperPod cluster.
DescribeClusterResponse.Builder	nodeRecovery(ClusterNodeRecovery nodeRecovery)	The node recovery mode configured for the SageMaker HyperPod cluster.
default DescribeClusterResponse.Builder	orchestrator(Consumer<ClusterOrchestrator.Builder> orchestrator)	The type of orchestrator used for the SageMaker HyperPod cluster.
DescribeClusterResponse.Builder	orchestrator(ClusterOrchestrator orchestrator)	The type of orchestrator used for the SageMaker HyperPod cluster.
default DescribeClusterResponse.Builder	vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)	Sets the value of the VpcConfig property for this object.
DescribeClusterResponse.Builder	vpcConfig(VpcConfig vpcConfig)	Sets the value of the VpcConfig property for this object.

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

copy

Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerResponse.Builder

build, responseMetadata, responseMetadata

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

clusterArn

DescribeClusterResponse.Builder clusterArn(String clusterArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

clusterName

DescribeClusterResponse.Builder clusterName(String clusterName)

The name of the SageMaker HyperPod cluster.

Parameters:

clusterName - The name of the SageMaker HyperPod cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

clusterStatus

DescribeClusterResponse.Builder clusterStatus(String clusterStatus)

The status of the SageMaker HyperPod cluster.

Parameters:

clusterStatus - The status of the SageMaker HyperPod cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ClusterStatus
• ClusterStatus

clusterStatus

DescribeClusterResponse.Builder clusterStatus(ClusterStatus clusterStatus)

The status of the SageMaker HyperPod cluster.

Parameters:

clusterStatus - The status of the SageMaker HyperPod cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ClusterStatus
• ClusterStatus

creationTime

DescribeClusterResponse.Builder creationTime(Instant creationTime)

The time when the SageMaker Cluster is created.

Parameters:

creationTime - The time when the SageMaker Cluster is created.

Returns:

Returns a reference to this object so that method calls can be chained together.

failureMessage

DescribeClusterResponse.Builder failureMessage(String failureMessage)

The failure message of the SageMaker HyperPod cluster.

Parameters:

failureMessage - The failure message of the SageMaker HyperPod cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceGroups

DescribeClusterResponse.Builder instanceGroups(Collection<ClusterInstanceGroupDetails> instanceGroups)

The instance groups of the SageMaker HyperPod cluster.

Parameters:

instanceGroups - The instance groups of the SageMaker HyperPod cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceGroups

DescribeClusterResponse.Builder instanceGroups(ClusterInstanceGroupDetails... instanceGroups)

The instance groups of the SageMaker HyperPod cluster.

Parameters:

instanceGroups - The instance groups of the SageMaker HyperPod cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceGroups

DescribeClusterResponse.Builder instanceGroups(Consumer<ClusterInstanceGroupDetails.Builder>... instanceGroups)

The instance groups of the SageMaker HyperPod cluster.

This is a convenience method that creates an instance of the ClusterInstanceGroupDetails.Builder avoiding the need to create one manually via ClusterInstanceGroupDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instanceGroups(List<ClusterInstanceGroupDetails>).

Parameters:

instanceGroups - a consumer that will call methods on ClusterInstanceGroupDetails.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• instanceGroups(java.util.Collection<ClusterInstanceGroupDetails>)

vpcConfig

DescribeClusterResponse.Builder vpcConfig(VpcConfig vpcConfig)

Sets the value of the VpcConfig property for this object.

Parameters:

vpcConfig - The new value for the VpcConfig property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

vpcConfig

default DescribeClusterResponse.Builder vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)

Sets the value of the VpcConfig property for this object. This is a convenience method that creates an instance of the VpcConfig.Builder avoiding the need to create one manually via VpcConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfig(VpcConfig).

Parameters:

vpcConfig - a consumer that will call methods on VpcConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• vpcConfig(VpcConfig)

orchestrator

DescribeClusterResponse.Builder orchestrator(ClusterOrchestrator orchestrator)

The type of orchestrator used for the SageMaker HyperPod cluster.

Parameters:

orchestrator - The type of orchestrator used for the SageMaker HyperPod cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

orchestrator

default DescribeClusterResponse.Builder orchestrator(Consumer<ClusterOrchestrator.Builder> orchestrator)

The type of orchestrator used for the SageMaker HyperPod cluster.

This is a convenience method that creates an instance of the ClusterOrchestrator.Builder avoiding the need to create one manually via ClusterOrchestrator.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to orchestrator(ClusterOrchestrator).

Parameters:

orchestrator - a consumer that will call methods on ClusterOrchestrator.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• orchestrator(ClusterOrchestrator)

nodeRecovery

DescribeClusterResponse.Builder nodeRecovery(String nodeRecovery)

The node recovery mode configured for the SageMaker HyperPod cluster.

Parameters:

nodeRecovery - The node recovery mode configured for the SageMaker HyperPod cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ClusterNodeRecovery
• ClusterNodeRecovery

nodeRecovery

DescribeClusterResponse.Builder nodeRecovery(ClusterNodeRecovery nodeRecovery)

The node recovery mode configured for the SageMaker HyperPod cluster.

Parameters:

nodeRecovery - The node recovery mode configured for the SageMaker HyperPod cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ClusterNodeRecovery
• ClusterNodeRecovery