Interface BatchAddClusterNodesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<BatchAddClusterNodesRequest.Builder,BatchAddClusterNodesRequest>, SageMakerRequest.Builder, SdkBuilder<BatchAddClusterNodesRequest.Builder,BatchAddClusterNodesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

BatchAddClusterNodesRequest

@Mutable
@NotThreadSafe
public static interface BatchAddClusterNodesRequest.Builder
extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<BatchAddClusterNodesRequest.Builder,BatchAddClusterNodesRequest>

Method Summary

Modifier and Type	Method	Description
BatchAddClusterNodesRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
BatchAddClusterNodesRequest.Builder	clusterName(String clusterName)	The name of the HyperPod cluster to which you want to add nodes.
BatchAddClusterNodesRequest.Builder	nodesToAdd(Collection<AddClusterNodeSpecification> nodesToAdd)	A list of instance groups and the number of nodes to add to each.
BatchAddClusterNodesRequest.Builder	nodesToAdd(Consumer<AddClusterNodeSpecification.Builder>... nodesToAdd)	A list of instance groups and the number of nodes to add to each.
BatchAddClusterNodesRequest.Builder	nodesToAdd(AddClusterNodeSpecification... nodesToAdd)	A list of instance groups and the number of nodes to add to each.
BatchAddClusterNodesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
BatchAddClusterNodesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

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

build

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

clusterName

BatchAddClusterNodesRequest.Builder clusterName(String clusterName)

The name of the HyperPod cluster to which you want to add nodes.

Parameters:

clusterName - The name of the HyperPod cluster to which you want to add nodes.

Returns:

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

clientToken

BatchAddClusterNodesRequest.Builder clientToken(String clientToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is valid for 8 hours. If you retry the request with the same client token within this timeframe and the same parameters, the API returns the same set of NodeLogicalIds with their latest status.

Parameters:

clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is valid for 8 hours. If you retry the request with the same client token within this timeframe and the same parameters, the API returns the same set of NodeLogicalIds with their latest status.

Returns:

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

nodesToAdd

BatchAddClusterNodesRequest.Builder nodesToAdd(Collection<AddClusterNodeSpecification> nodesToAdd)

A list of instance groups and the number of nodes to add to each. You can specify up to 5 instance groups in a single request, with a maximum of 50 nodes total across all instance groups.

Parameters:

nodesToAdd - A list of instance groups and the number of nodes to add to each. You can specify up to 5 instance groups in a single request, with a maximum of 50 nodes total across all instance groups.

Returns:

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

nodesToAdd

BatchAddClusterNodesRequest.Builder nodesToAdd(AddClusterNodeSpecification... nodesToAdd)

A list of instance groups and the number of nodes to add to each. You can specify up to 5 instance groups in a single request, with a maximum of 50 nodes total across all instance groups.

Parameters:

nodesToAdd - A list of instance groups and the number of nodes to add to each. You can specify up to 5 instance groups in a single request, with a maximum of 50 nodes total across all instance groups.

Returns:

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

nodesToAdd

BatchAddClusterNodesRequest.Builder nodesToAdd(Consumer<AddClusterNodeSpecification.Builder>... nodesToAdd)

A list of instance groups and the number of nodes to add to each. You can specify up to 5 instance groups in a single request, with a maximum of 50 nodes total across all instance groups.

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

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

Parameters:

nodesToAdd - a consumer that will call methods on AddClusterNodeSpecification.Builder

Returns:

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

See Also:

• nodesToAdd(java.util.Collection<AddClusterNodeSpecification>)

overrideConfiguration

BatchAddClusterNodesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

BatchAddClusterNodesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.