Class BatchReplaceClusterNodesRequest

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.BatchReplaceClusterNodesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<BatchReplaceClusterNodesRequest.Builder,BatchReplaceClusterNodesRequest>
@Generated("software.amazon.awssdk:codegen") public final class BatchReplaceClusterNodesRequest extends SageMakerRequest implements ToCopyableBuilder<BatchReplaceClusterNodesRequest.Builder,BatchReplaceClusterNodesRequest>

  • Method Details

    • clusterName

      public final String clusterName()

      The name or Amazon Resource Name (ARN) of the SageMaker HyperPod cluster containing the nodes to replace.

      Returns:
      The name or Amazon Resource Name (ARN) of the SageMaker HyperPod cluster containing the nodes to replace.

    • hasNodeIds

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

    • nodeIds

      public final List<String> nodeIds()

      A list of EC2 instance IDs to replace with new hardware. You can specify between 1 and 25 instance IDs.

      Replace operations destroy all instance volumes (root and secondary). Ensure you have backed up any important data before proceeding.

      • Either NodeIds or NodeLogicalIds must be provided (or both), but at least one is required.

      • Each instance ID must follow the pattern i- followed by 17 hexadecimal characters (for example, i-0123456789abcdef0).

      • For SageMaker HyperPod clusters using the Slurm workload manager, you cannot replace instances that are configured as Slurm controller nodes.

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

      Returns:
      A list of EC2 instance IDs to replace with new hardware. You can specify between 1 and 25 instance IDs.

      Replace operations destroy all instance volumes (root and secondary). Ensure you have backed up any important data before proceeding.

      • Either NodeIds or NodeLogicalIds must be provided (or both), but at least one is required.

      • Each instance ID must follow the pattern i- followed by 17 hexadecimal characters (for example, i-0123456789abcdef0).

      • For SageMaker HyperPod clusters using the Slurm workload manager, you cannot replace instances that are configured as Slurm controller nodes.

    • hasNodeLogicalIds

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

    • nodeLogicalIds

      public final List<String> nodeLogicalIds()

      A list of logical node IDs to replace with new hardware. You can specify between 1 and 25 logical node IDs.

      The NodeLogicalId is a unique identifier that persists throughout the node's lifecycle and can be used to track nodes that are still being provisioned and don't yet have an EC2 instance ID assigned.

      • Replace operations destroy all instance volumes (root and secondary). Ensure you have backed up any important data before proceeding.

      • This parameter is only supported for clusters using Continuous as the NodeProvisioningMode. For clusters using the default provisioning mode, use NodeIds instead.

      • Either NodeIds or NodeLogicalIds must be provided (or both), but at least one is required.

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

      Returns:
      A list of logical node IDs to replace with new hardware. You can specify between 1 and 25 logical node IDs.

      The NodeLogicalId is a unique identifier that persists throughout the node's lifecycle and can be used to track nodes that are still being provisioned and don't yet have an EC2 instance ID assigned.

      • Replace operations destroy all instance volumes (root and secondary). Ensure you have backed up any important data before proceeding.

      • This parameter is only supported for clusters using Continuous as the NodeProvisioningMode. For clusters using the default provisioning mode, use NodeIds instead.

      • Either NodeIds or NodeLogicalIds must be provided (or both), but at least one is required.

    • toBuilder

      public BatchReplaceClusterNodesRequest.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<BatchReplaceClusterNodesRequest.Builder,BatchReplaceClusterNodesRequest>
      Specified by:
      toBuilder in class SageMakerRequest
      Returns:
      a builder for type T

    • builder

      public static BatchReplaceClusterNodesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BatchReplaceClusterNodesRequest.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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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