Class DeepHealthCheckOnStart

java.lang.Object
software.amazon.awssdk.services.pcs.model.DeepHealthCheckOnStart
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DeepHealthCheckOnStart.Builder,DeepHealthCheckOnStart>

@Generated("software.amazon.awssdk:codegen") public final class DeepHealthCheckOnStart extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DeepHealthCheckOnStart.Builder,DeepHealthCheckOnStart>

The deep health check that runs each time an instance starts, including after a reboot, before the compute node accepts jobs.

See Also:
  • Method Details

    • profile

      public final DeepHealthCheckOnStartProfile profile()

      The deep health check profile to run. Each profile other than NONE runs NVIDIA Data Center GPU Manager (DCGM) diagnostics. More thorough profiles run more tests and add more time to instance launch. A profile other than NONE requires instance types with NVIDIA GPUs. This value is required when you specify onStart. There is no default value. Valid values:

      • NONE – Turns off the deep health check. You can't specify repairAction with this profile.

      • QUICK – Runs basic GPU tests (DCGM diagnostics level 1). This profile adds the least time to instance launch.

      • MEDIUM – Runs extended GPU tests (DCGM diagnostics level 2).

      • LONG – Runs GPU stress and diagnostic tests (DCGM diagnostics level 3). This profile adds the most time to instance launch.

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

      Returns:
      The deep health check profile to run. Each profile other than NONE runs NVIDIA Data Center GPU Manager (DCGM) diagnostics. More thorough profiles run more tests and add more time to instance launch. A profile other than NONE requires instance types with NVIDIA GPUs. This value is required when you specify onStart. There is no default value. Valid values:

      • NONE – Turns off the deep health check. You can't specify repairAction with this profile.

      • QUICK – Runs basic GPU tests (DCGM diagnostics level 1). This profile adds the least time to instance launch.

      • MEDIUM – Runs extended GPU tests (DCGM diagnostics level 2).

      • LONG – Runs GPU stress and diagnostic tests (DCGM diagnostics level 3). This profile adds the most time to instance launch.

      See Also:
    • profileAsString

      public final String profileAsString()

      The deep health check profile to run. Each profile other than NONE runs NVIDIA Data Center GPU Manager (DCGM) diagnostics. More thorough profiles run more tests and add more time to instance launch. A profile other than NONE requires instance types with NVIDIA GPUs. This value is required when you specify onStart. There is no default value. Valid values:

      • NONE – Turns off the deep health check. You can't specify repairAction with this profile.

      • QUICK – Runs basic GPU tests (DCGM diagnostics level 1). This profile adds the least time to instance launch.

      • MEDIUM – Runs extended GPU tests (DCGM diagnostics level 2).

      • LONG – Runs GPU stress and diagnostic tests (DCGM diagnostics level 3). This profile adds the most time to instance launch.

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

      Returns:
      The deep health check profile to run. Each profile other than NONE runs NVIDIA Data Center GPU Manager (DCGM) diagnostics. More thorough profiles run more tests and add more time to instance launch. A profile other than NONE requires instance types with NVIDIA GPUs. This value is required when you specify onStart. There is no default value. Valid values:

      • NONE – Turns off the deep health check. You can't specify repairAction with this profile.

      • QUICK – Runs basic GPU tests (DCGM diagnostics level 1). This profile adds the least time to instance launch.

      • MEDIUM – Runs extended GPU tests (DCGM diagnostics level 2).

      • LONG – Runs GPU stress and diagnostic tests (DCGM diagnostics level 3). This profile adds the most time to instance launch.

      See Also:
    • repairAction

      public final DeepHealthCheckOnStartRepairAction repairAction()

      The action that PCS takes when an instance fails the deep health check. You can't specify this value when profile is NONE. If you don't specify this value and profile isn't NONE, PCS uses AUTO. GetComputeNodeGroup doesn't return a repairAction that you didn't specify. Valid values:

      • AUTO – PCS chooses the repair action based on the fault.

      • REPLACE – Replaces the instance before it accepts jobs.

      • ISOLATE – Stops new jobs on the instance and keeps the instance running until you investigate.

      • NONE – Records the fault in Slurm and leaves the instance available for jobs.

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

      Returns:
      The action that PCS takes when an instance fails the deep health check. You can't specify this value when profile is NONE. If you don't specify this value and profile isn't NONE, PCS uses AUTO. GetComputeNodeGroup doesn't return a repairAction that you didn't specify. Valid values:

      • AUTO – PCS chooses the repair action based on the fault.

      • REPLACE – Replaces the instance before it accepts jobs.

      • ISOLATE – Stops new jobs on the instance and keeps the instance running until you investigate.

      • NONE – Records the fault in Slurm and leaves the instance available for jobs.

      See Also:
    • repairActionAsString

      public final String repairActionAsString()

      The action that PCS takes when an instance fails the deep health check. You can't specify this value when profile is NONE. If you don't specify this value and profile isn't NONE, PCS uses AUTO. GetComputeNodeGroup doesn't return a repairAction that you didn't specify. Valid values:

      • AUTO – PCS chooses the repair action based on the fault.

      • REPLACE – Replaces the instance before it accepts jobs.

      • ISOLATE – Stops new jobs on the instance and keeps the instance running until you investigate.

      • NONE – Records the fault in Slurm and leaves the instance available for jobs.

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

      Returns:
      The action that PCS takes when an instance fails the deep health check. You can't specify this value when profile is NONE. If you don't specify this value and profile isn't NONE, PCS uses AUTO. GetComputeNodeGroup doesn't return a repairAction that you didn't specify. Valid values:

      • AUTO – PCS chooses the repair action based on the fault.

      • REPLACE – Replaces the instance before it accepts jobs.

      • ISOLATE – Stops new jobs on the instance and keeps the instance running until you investigate.

      • NONE – Records the fault in Slurm and leaves the instance available for jobs.

      See Also:
    • toBuilder

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

      public static DeepHealthCheckOnStart.Builder builder()
    • serializableBuilderClass

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