Class NodeAdditionResult

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

Information about a node that was successfully added to the cluster.

See Also:

  • Method Details

    • nodeLogicalId

      public final String nodeLogicalId()

      A unique identifier assigned to the node that can be used to track its provisioning status through the DescribeClusterNode operation.

      Returns:
      A unique identifier assigned to the node that can be used to track its provisioning status through the DescribeClusterNode operation.

    • instanceGroupName

      public final String instanceGroupName()

      The name of the instance group to which the node was added.

      Returns:
      The name of the instance group to which the node was added.

    • status

      public final ClusterInstanceStatus status()

      The current status of the node. Possible values include Pending, Running, Failed, ShuttingDown, SystemUpdating, DeepHealthCheckInProgress, and NotFound.

      If the service returns an enum value that is not available in the current SDK version, status will return ClusterInstanceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the node. Possible values include Pending, Running, Failed, ShuttingDown, SystemUpdating, DeepHealthCheckInProgress, and NotFound.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the node. Possible values include Pending, Running, Failed, ShuttingDown, SystemUpdating, DeepHealthCheckInProgress, and NotFound.

      If the service returns an enum value that is not available in the current SDK version, status will return ClusterInstanceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the node. Possible values include Pending, Running, Failed, ShuttingDown, SystemUpdating, DeepHealthCheckInProgress, and NotFound.
      See Also:

    • hasAvailabilityZones

      public final boolean hasAvailabilityZones()
      For responses, this returns true if the service returned a value for the AvailabilityZones 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.

    • availabilityZones

      public final List<String> availabilityZones()

      The availability zones associated with the successfully added node.

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

      Returns:
      The availability zones associated with the successfully added node.

    • instanceTypes

      public final List<ClusterInstanceType> instanceTypes()

      The instance types associated with the successfully added node.

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

      Returns:
      The instance types associated with the successfully added node.

    • hasInstanceTypes

      public final boolean hasInstanceTypes()
      For responses, this returns true if the service returned a value for the InstanceTypes 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.

    • instanceTypesAsStrings

      public final List<String> instanceTypesAsStrings()

      The instance types associated with the successfully added node.

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

      Returns:
      The instance types associated with the successfully added node.

    • toBuilder

      public NodeAdditionResult.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<NodeAdditionResult.Builder,NodeAdditionResult>
      Returns:
      a builder for type T

    • builder

      public static NodeAdditionResult.Builder builder()

    • serializableBuilderClass

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