ClusterNodeDetails (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.sagemaker.model.ClusterNodeDetails

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ClusterNodeDetails
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Details of an instance (also called a node interchangeably) in a SageMaker HyperPod cluster.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ClusterNodeDetails()

Constructors
Constructor and Description
`ClusterNodeDetails()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClusterNodeDetails`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getInstanceGroupName()` The instance group name in which the instance is.
`String`	`getInstanceId()` The ID of the instance.
`ClusterInstanceStatusDetails`	`getInstanceStatus()` The status of the instance.
`List<ClusterInstanceStorageConfig>`	`getInstanceStorageConfigs()` The configurations of additional storage specified to the instance group where the instance (node) is launched.
`String`	`getInstanceType()` The type of the instance.
`Date`	`getLaunchTime()` The time when the instance is launched.
`ClusterLifeCycleConfig`	`getLifeCycleConfig()` The LifeCycle configuration applied to the instance.
`ClusterInstancePlacement`	`getPlacement()` The placement details of the SageMaker HyperPod cluster node.
`String`	`getPrivateDnsHostname()` The private DNS hostname of the SageMaker HyperPod cluster node.
`String`	`getPrivatePrimaryIp()` The private primary IP address of the SageMaker HyperPod cluster node.
`Integer`	`getThreadsPerCore()` The number of threads per CPU core you specified under `CreateCluster`.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setInstanceGroupName(String instanceGroupName)` The instance group name in which the instance is.
`void`	`setInstanceId(String instanceId)` The ID of the instance.
`void`	`setInstanceStatus(ClusterInstanceStatusDetails instanceStatus)` The status of the instance.
`void`	`setInstanceStorageConfigs(Collection<ClusterInstanceStorageConfig> instanceStorageConfigs)` The configurations of additional storage specified to the instance group where the instance (node) is launched.
`void`	`setInstanceType(String instanceType)` The type of the instance.
`void`	`setLaunchTime(Date launchTime)` The time when the instance is launched.
`void`	`setLifeCycleConfig(ClusterLifeCycleConfig lifeCycleConfig)` The LifeCycle configuration applied to the instance.
`void`	`setPlacement(ClusterInstancePlacement placement)` The placement details of the SageMaker HyperPod cluster node.
`void`	`setPrivateDnsHostname(String privateDnsHostname)` The private DNS hostname of the SageMaker HyperPod cluster node.
`void`	`setPrivatePrimaryIp(String privatePrimaryIp)` The private primary IP address of the SageMaker HyperPod cluster node.
`void`	`setThreadsPerCore(Integer threadsPerCore)` The number of threads per CPU core you specified under `CreateCluster`.
`String`	`toString()` Returns a string representation of this object.
`ClusterNodeDetails`	`withInstanceGroupName(String instanceGroupName)` The instance group name in which the instance is.
`ClusterNodeDetails`	`withInstanceId(String instanceId)` The ID of the instance.
`ClusterNodeDetails`	`withInstanceStatus(ClusterInstanceStatusDetails instanceStatus)` The status of the instance.
`ClusterNodeDetails`	`withInstanceStorageConfigs(ClusterInstanceStorageConfig... instanceStorageConfigs)` The configurations of additional storage specified to the instance group where the instance (node) is launched.
`ClusterNodeDetails`	`withInstanceStorageConfigs(Collection<ClusterInstanceStorageConfig> instanceStorageConfigs)` The configurations of additional storage specified to the instance group where the instance (node) is launched.
`ClusterNodeDetails`	`withInstanceType(ClusterInstanceType instanceType)` The type of the instance.
`ClusterNodeDetails`	`withInstanceType(String instanceType)` The type of the instance.
`ClusterNodeDetails`	`withLaunchTime(Date launchTime)` The time when the instance is launched.
`ClusterNodeDetails`	`withLifeCycleConfig(ClusterLifeCycleConfig lifeCycleConfig)` The LifeCycle configuration applied to the instance.
`ClusterNodeDetails`	`withPlacement(ClusterInstancePlacement placement)` The placement details of the SageMaker HyperPod cluster node.
`ClusterNodeDetails`	`withPrivateDnsHostname(String privateDnsHostname)` The private DNS hostname of the SageMaker HyperPod cluster node.
`ClusterNodeDetails`	`withPrivatePrimaryIp(String privatePrimaryIp)` The private primary IP address of the SageMaker HyperPod cluster node.
`ClusterNodeDetails`	`withThreadsPerCore(Integer threadsPerCore)` The number of threads per CPU core you specified under `CreateCluster`.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ClusterNodeDetails
```
public ClusterNodeDetails()
```
- Method Detail
  - setInstanceGroupName
```
public void setInstanceGroupName(String instanceGroupName)
```
    The instance group name in which the instance is.
    
    Parameters:
    
    instanceGroupName - The instance group name in which the instance is.
  - getInstanceGroupName
```
public String getInstanceGroupName()
```
    The instance group name in which the instance is.
    
    Returns:
    
    The instance group name in which the instance is.
  - withInstanceGroupName
```
public ClusterNodeDetails withInstanceGroupName(String instanceGroupName)
```
    The instance group name in which the instance is.
    
    Parameters:
    
    instanceGroupName - The instance group name in which the instance is.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceId
```
public void setInstanceId(String instanceId)
```
    The ID of the instance.
    
    Parameters:
    
    instanceId - The ID of the instance.
  - getInstanceId
```
public String getInstanceId()
```
    The ID of the instance.
    
    Returns:
    
    The ID of the instance.
  - withInstanceId
```
public ClusterNodeDetails withInstanceId(String instanceId)
```
    The ID of the instance.
    
    Parameters:
    
    instanceId - The ID of the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceStatus
```
public void setInstanceStatus(ClusterInstanceStatusDetails instanceStatus)
```
    The status of the instance.
    
    Parameters:
    
    instanceStatus - The status of the instance.
  - getInstanceStatus
```
public ClusterInstanceStatusDetails getInstanceStatus()
```
    The status of the instance.
    
    Returns:
    
    The status of the instance.
  - withInstanceStatus
```
public ClusterNodeDetails withInstanceStatus(ClusterInstanceStatusDetails instanceStatus)
```
    The status of the instance.
    
    Parameters:
    
    instanceStatus - The status of the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceType
```
public void setInstanceType(String instanceType)
```
    The type of the instance.
    
    Parameters:
    
    instanceType - The type of the instance.
    
    See Also:
    
    ClusterInstanceType
  - getInstanceType
```
public String getInstanceType()
```
    The type of the instance.
    
    Returns:
    
    The type of the instance.
    
    See Also:
    
    ClusterInstanceType
  - withInstanceType
```
public ClusterNodeDetails withInstanceType(String instanceType)
```
    The type of the instance.
    
    Parameters:
    
    instanceType - The type of the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ClusterInstanceType
  - withInstanceType
```
public ClusterNodeDetails withInstanceType(ClusterInstanceType instanceType)
```
    The type of the instance.
    
    Parameters:
    
    instanceType - The type of the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ClusterInstanceType
  - setLaunchTime
```
public void setLaunchTime(Date launchTime)
```
    The time when the instance is launched.
    
    Parameters:
    
    launchTime - The time when the instance is launched.
  - getLaunchTime
```
public Date getLaunchTime()
```
    The time when the instance is launched.
    
    Returns:
    
    The time when the instance is launched.
  - withLaunchTime
```
public ClusterNodeDetails withLaunchTime(Date launchTime)
```
    The time when the instance is launched.
    
    Parameters:
    
    launchTime - The time when the instance is launched.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLifeCycleConfig
```
public void setLifeCycleConfig(ClusterLifeCycleConfig lifeCycleConfig)
```
    The LifeCycle configuration applied to the instance.
    
    Parameters:
    
    lifeCycleConfig - The LifeCycle configuration applied to the instance.
  - getLifeCycleConfig
```
public ClusterLifeCycleConfig getLifeCycleConfig()
```
    The LifeCycle configuration applied to the instance.
    
    Returns:
    
    The LifeCycle configuration applied to the instance.
  - withLifeCycleConfig
```
public ClusterNodeDetails withLifeCycleConfig(ClusterLifeCycleConfig lifeCycleConfig)
```
    The LifeCycle configuration applied to the instance.
    
    Parameters:
    
    lifeCycleConfig - The LifeCycle configuration applied to the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setThreadsPerCore
```
public void setThreadsPerCore(Integer threadsPerCore)
```
    The number of threads per CPU core you specified under CreateCluster.
    
    Parameters:
    
    threadsPerCore - The number of threads per CPU core you specified under CreateCluster.
  - getThreadsPerCore
```
public Integer getThreadsPerCore()
```
    The number of threads per CPU core you specified under CreateCluster.
    
    Returns:
    
    The number of threads per CPU core you specified under CreateCluster.
  - withThreadsPerCore
```
public ClusterNodeDetails withThreadsPerCore(Integer threadsPerCore)
```
    The number of threads per CPU core you specified under CreateCluster.
    
    Parameters:
    
    threadsPerCore - The number of threads per CPU core you specified under CreateCluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInstanceStorageConfigs
```
public List<ClusterInstanceStorageConfig> getInstanceStorageConfigs()
```
    The configurations of additional storage specified to the instance group where the instance (node) is launched.
    
    Returns:
    
    The configurations of additional storage specified to the instance group where the instance (node) is launched.
  - setInstanceStorageConfigs
```
public void setInstanceStorageConfigs(Collection<ClusterInstanceStorageConfig> instanceStorageConfigs)
```
    The configurations of additional storage specified to the instance group where the instance (node) is launched.
    
    Parameters:
    
    instanceStorageConfigs - The configurations of additional storage specified to the instance group where the instance (node) is launched.
  - withInstanceStorageConfigs
```
public ClusterNodeDetails withInstanceStorageConfigs(ClusterInstanceStorageConfig... instanceStorageConfigs)
```
    The configurations of additional storage specified to the instance group where the instance (node) is launched.
    
    NOTE: This method appends the values to the existing list (if any). Use setInstanceStorageConfigs(java.util.Collection) or withInstanceStorageConfigs(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    instanceStorageConfigs - The configurations of additional storage specified to the instance group where the instance (node) is launched.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInstanceStorageConfigs
```
public ClusterNodeDetails withInstanceStorageConfigs(Collection<ClusterInstanceStorageConfig> instanceStorageConfigs)
```
    The configurations of additional storage specified to the instance group where the instance (node) is launched.
    
    Parameters:
    
    instanceStorageConfigs - The configurations of additional storage specified to the instance group where the instance (node) is launched.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPrivatePrimaryIp
```
public void setPrivatePrimaryIp(String privatePrimaryIp)
```
    The private primary IP address of the SageMaker HyperPod cluster node.
    
    Parameters:
    
    privatePrimaryIp - The private primary IP address of the SageMaker HyperPod cluster node.
  - getPrivatePrimaryIp
```
public String getPrivatePrimaryIp()
```
    The private primary IP address of the SageMaker HyperPod cluster node.
    
    Returns:
    
    The private primary IP address of the SageMaker HyperPod cluster node.
  - withPrivatePrimaryIp
```
public ClusterNodeDetails withPrivatePrimaryIp(String privatePrimaryIp)
```
    The private primary IP address of the SageMaker HyperPod cluster node.
    
    Parameters:
    
    privatePrimaryIp - The private primary IP address of the SageMaker HyperPod cluster node.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPrivateDnsHostname
```
public void setPrivateDnsHostname(String privateDnsHostname)
```
    The private DNS hostname of the SageMaker HyperPod cluster node.
    
    Parameters:
    
    privateDnsHostname - The private DNS hostname of the SageMaker HyperPod cluster node.
  - getPrivateDnsHostname
```
public String getPrivateDnsHostname()
```
    The private DNS hostname of the SageMaker HyperPod cluster node.
    
    Returns:
    
    The private DNS hostname of the SageMaker HyperPod cluster node.
  - withPrivateDnsHostname
```
public ClusterNodeDetails withPrivateDnsHostname(String privateDnsHostname)
```
    The private DNS hostname of the SageMaker HyperPod cluster node.
    
    Parameters:
    
    privateDnsHostname - The private DNS hostname of the SageMaker HyperPod cluster node.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPlacement
```
public void setPlacement(ClusterInstancePlacement placement)
```
    The placement details of the SageMaker HyperPod cluster node.
    
    Parameters:
    
    placement - The placement details of the SageMaker HyperPod cluster node.
  - getPlacement
```
public ClusterInstancePlacement getPlacement()
```
    The placement details of the SageMaker HyperPod cluster node.
    
    Returns:
    
    The placement details of the SageMaker HyperPod cluster node.
  - withPlacement
```
public ClusterNodeDetails withPlacement(ClusterInstancePlacement placement)
```
    The placement details of the SageMaker HyperPod cluster node.
    
    Parameters:
    
    placement - The placement details of the SageMaker HyperPod cluster node.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ClusterNodeDetails clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class ClusterNodeDetails

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClusterNodeDetails

Method Detail

setInstanceGroupName

getInstanceGroupName

withInstanceGroupName

setInstanceId

getInstanceId

withInstanceId

setInstanceStatus

getInstanceStatus

withInstanceStatus

setInstanceType

getInstanceType

withInstanceType

withInstanceType

setLaunchTime

getLaunchTime

withLaunchTime

setLifeCycleConfig

getLifeCycleConfig

withLifeCycleConfig

setThreadsPerCore

getThreadsPerCore

withThreadsPerCore

getInstanceStorageConfigs

setInstanceStorageConfigs

withInstanceStorageConfigs

withInstanceStorageConfigs

setPrivatePrimaryIp

getPrivatePrimaryIp

withPrivatePrimaryIp

setPrivateDnsHostname

getPrivateDnsHostname

withPrivateDnsHostname

setPlacement

getPlacement

withPlacement

toString

equals

hashCode

clone

marshall