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

Class BatchAddClusterNodesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemaker.model.SageMakerRequest

software.amazon.awssdk.services.sagemaker.model.BatchAddClusterNodesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchAddClusterNodesRequest.Builder,BatchAddClusterNodesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchAddClusterNodesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static BatchAddClusterNodesRequest.Builder	builder()
String	clientToken()	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	clusterName()	The name of the HyperPod cluster to which you want to add nodes.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasNodesToAdd()	For responses, this returns true if the service returned a value for the NodesToAdd property.
List<AddClusterNodeSpecification>	nodesToAdd()	A list of instance groups and the number of nodes to add to each.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends BatchAddClusterNodesRequest.Builder>	serializableBuilderClass()
BatchAddClusterNodesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

clusterName

public final String clusterName()

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

Returns:

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

clientToken

public final 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.

Returns:

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.

hasNodesToAdd

public final boolean hasNodesToAdd()

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

nodesToAdd

public final List<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.

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

Returns:

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.

toBuilder

public BatchAddClusterNodesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchAddClusterNodesRequest.Builder,BatchAddClusterNodesRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static BatchAddClusterNodesRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

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