Class ClusterNodeSummary

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.ClusterNodeSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ClusterNodeSummary.Builder,ClusterNodeSummary>
@Generated("software.amazon.awssdk:codegen") public final class ClusterNodeSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ClusterNodeSummary.Builder,ClusterNodeSummary>

Lists a summary of the properties of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.

See Also:

  • Method Details

    • instanceGroupName

      public final String instanceGroupName()

      The name of the instance group in which the instance is.

      Returns:
      The name of the instance group in which the instance is.

    • instanceId

      public final String instanceId()

      The ID of the instance.

      Returns:
      The ID of the instance.

    • nodeLogicalId

      public final String nodeLogicalId()

      A unique identifier for the node that persists throughout its lifecycle, from provisioning request to termination. This identifier can be used to track the node even before it has an assigned InstanceId . This field is only included when IncludeNodeLogicalIds is set to True in the ListClusterNodes request.

      Returns:
      A unique identifier for the node that persists throughout its lifecycle, from provisioning request to termination. This identifier can be used to track the node even before it has an assigned InstanceId. This field is only included when IncludeNodeLogicalIds is set to True in the ListClusterNodes request.

    • 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:

    • 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:

    • launchTime

      public final Instant launchTime()

      The time when the instance is launched.

      Returns:
      The time when the instance is launched.

    • lastSoftwareUpdateTime

      public final Instant lastSoftwareUpdateTime()

      The time when SageMaker last updated the software of the instances in the cluster.

      Returns:
      The time when SageMaker last updated the software of the instances in the cluster.

    • instanceStatus

      public final ClusterInstanceStatusDetails instanceStatus()

      The status of the instance.

      Returns:
      The status of the instance.

    • ultraServerInfo

      public final UltraServerInfo ultraServerInfo()

      Contains information about the UltraServer.

      Returns:
      Contains information about the UltraServer.

    • toBuilder

      public ClusterNodeSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ClusterNodeSummary.Builder,ClusterNodeSummary>
      Returns:
      a builder for type T

    • builder

      public static ClusterNodeSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ClusterNodeSummary.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.