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

Class CreateClusterRequest

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.CreateClusterRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateClusterRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateClusterRequest.Builder	builder()
String	clusterName()	The name for the new SageMaker HyperPod cluster.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<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.
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
List<ClusterInstanceGroupSpecification>	instanceGroups()	The instance groups to be created in the SageMaker HyperPod cluster.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateClusterRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource.
CreateClusterRequest.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.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 for the new SageMaker HyperPod cluster.

Returns:

The name for the new 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<ClusterInstanceGroupSpecification> instanceGroups()

The instance groups to be created in 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 to be created in 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.

hasTags

public final boolean hasTags()

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

tags

public final List<Tag> tags()

Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide.

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

Returns:

Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide.

toBuilder

public CreateClusterRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static CreateClusterRequest.Builder builder()

serializableBuilderClass

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