java.lang.Object
- software.amazon.awssdk.services.sagemaker.model.ClusterNodeDetails

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ClusterNodeDetails.Builder,ClusterNodeDetails>
```
@Generated("software.amazon.awssdk:codegen")
public final class ClusterNodeDetails
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ClusterNodeDetails.Builder,ClusterNodeDetails>
```
Details of an instance (also called a node interchangeably) in a SageMaker HyperPod cluster.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ClusterNodeDetails.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ClusterNodeDetails.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasInstanceStorageConfigs()`	For responses, this returns true if the service returned a value for the InstanceStorageConfigs property.
`String`	`instanceGroupName()`	The instance group name in which the instance is.
`String`	`instanceId()`	The ID of the instance.
`ClusterInstanceStatusDetails`	`instanceStatus()`	The status of the instance.
`List<ClusterInstanceStorageConfig>`	`instanceStorageConfigs()`	The configurations of additional storage specified to the instance group where the instance (node) is launched.
`ClusterInstanceType`	`instanceType()`	The type of the instance.
`String`	`instanceTypeAsString()`	The type of the instance.
`Instant`	`launchTime()`	The time when the instance is launched.
`ClusterLifeCycleConfig`	`lifeCycleConfig()`	The LifeCycle configuration applied to the instance.
`ClusterInstancePlacement`	`placement()`	The placement details of the SageMaker HyperPod cluster node.
`String`	`privateDnsHostname()`	The private DNS hostname of the SageMaker HyperPod cluster node.
`String`	`privatePrimaryIp()`	The private primary IP address of the SageMaker HyperPod cluster node.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ClusterNodeDetails.Builder>`	`serializableBuilderClass()`
`Integer`	`threadsPerCore()`	The number of threads per CPU core you specified under `CreateCluster`.
`ClusterNodeDetails.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - instanceGroupName
```
public final String instanceGroupName()
```
    The instance group name in which the instance is.
    
    Returns:
    
    The instance group name in which the instance is.
  - instanceId
```
public final String instanceId()
```
    The ID of the instance.
    
    Returns:
    
    The ID of the instance.
  - instanceStatus
```
public final ClusterInstanceStatusDetails instanceStatus()
```
    The status of the instance.
    
    Returns:
    
    The status of the instance.
  - instanceType
```
public final ClusterInstanceType instanceType()
```
    The type of the instance.
    
    If the service returns an enum value that is not available in the current SDK version, instanceType will return ClusterInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().
    
    Returns:
    
    The type of the instance.
    
    See Also:
    
    ClusterInstanceType
  - instanceTypeAsString
```
public final String instanceTypeAsString()
```
    The type of the instance.
    
    If the service returns an enum value that is not available in the current SDK version, instanceType will return ClusterInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().
    
    Returns:
    
    The type of the instance.
    
    See Also:
    
    ClusterInstanceType
  - launchTime
```
public final Instant launchTime()
```
    The time when the instance is launched.
    
    Returns:
    
    The time when the instance is launched.
  - lifeCycleConfig
```
public final ClusterLifeCycleConfig lifeCycleConfig()
```
    The LifeCycle configuration applied to the instance.
    
    Returns:
    
    The LifeCycle configuration applied to the instance.
  - threadsPerCore
```
public final Integer threadsPerCore()
```
    The number of threads per CPU core you specified under CreateCluster.
    
    Returns:
    
    The number of threads per CPU core you specified under CreateCluster.
  - hasInstanceStorageConfigs
```
public final boolean hasInstanceStorageConfigs()
```
    For responses, this returns true if the service returned a value for the InstanceStorageConfigs 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.
  - instanceStorageConfigs
```
public final List<ClusterInstanceStorageConfig> instanceStorageConfigs()
```
    The configurations of additional storage specified to the instance group where the instance (node) is launched.
    
    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 hasInstanceStorageConfigs() method.
    
    Returns:
    
    The configurations of additional storage specified to the instance group where the instance (node) is launched.
  - privatePrimaryIp
```
public final String privatePrimaryIp()
```
    The private primary IP address of the SageMaker HyperPod cluster node.
    
    Returns:
    
    The private primary IP address of the SageMaker HyperPod cluster node.
  - privateDnsHostname
```
public final String privateDnsHostname()
```
    The private DNS hostname of the SageMaker HyperPod cluster node.
    
    Returns:
    
    The private DNS hostname of the SageMaker HyperPod cluster node.
  - placement
```
public final ClusterInstancePlacement placement()
```
    The placement details of the SageMaker HyperPod cluster node.
    
    Returns:
    
    The placement details of the SageMaker HyperPod cluster node.
  - toBuilder
```
public ClusterNodeDetails.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ClusterNodeDetails.Builder,ClusterNodeDetails>
  - builder
```
public static ClusterNodeDetails.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ClusterNodeDetails.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ClusterNodeDetails

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

instanceGroupName

instanceId

instanceStatus

instanceType

instanceTypeAsString

launchTime

lifeCycleConfig

threadsPerCore

hasInstanceStorageConfigs

instanceStorageConfigs

privatePrimaryIp

privateDnsHostname

placement

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields