Class SlurmHealthMetadata

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

Metadata information about the health of a Slurm component on the controller node of a HyperPod cluster.

See Also:

  • Method Details

    • component

      public final SlurmHealthComponent component()

      The Slurm component that the health information describes. The valid value is Slurmdbd, the Slurm accounting daemon.

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

      Returns:
      The Slurm component that the health information describes. The valid value is Slurmdbd, the Slurm accounting daemon.
      See Also:

    • componentAsString

      public final String componentAsString()

      The Slurm component that the health information describes. The valid value is Slurmdbd, the Slurm accounting daemon.

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

      Returns:
      The Slurm component that the health information describes. The valid value is Slurmdbd, the Slurm accounting daemon.
      See Also:

    • status

      public final SlurmHealthStatus status()

      The health of the component. Valid values are Healthy and Unhealthy.

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

      Returns:
      The health of the component. Valid values are Healthy and Unhealthy.
      See Also:

    • statusAsString

      public final String statusAsString()

      The health of the component. Valid values are Healthy and Unhealthy.

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

      Returns:
      The health of the component. Valid values are Healthy and Unhealthy.
      See Also:

    • reason

      public final SlurmHealthReason reason()

      The reason the component is unhealthy. Valid values:

      • DaemonDown: The daemon is not running, so job accounting records are not being written.

      • DaemonDisabled: The daemon is running and its accounting database is responding, but the daemon is not enabled to start automatically. Job accounting stops the next time the controller node restarts.

      • DbUnreachable: The daemon is running, but its accounting database did not respond. Job accounting records might not be written.

      This field is omitted when the component is healthy.

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

      Returns:
      The reason the component is unhealthy. Valid values:

      • DaemonDown: The daemon is not running, so job accounting records are not being written.

      • DaemonDisabled: The daemon is running and its accounting database is responding, but the daemon is not enabled to start automatically. Job accounting stops the next time the controller node restarts.

      • DbUnreachable: The daemon is running, but its accounting database did not respond. Job accounting records might not be written.

      This field is omitted when the component is healthy.

      See Also:

    • reasonAsString

      public final String reasonAsString()

      The reason the component is unhealthy. Valid values:

      • DaemonDown: The daemon is not running, so job accounting records are not being written.

      • DaemonDisabled: The daemon is running and its accounting database is responding, but the daemon is not enabled to start automatically. Job accounting stops the next time the controller node restarts.

      • DbUnreachable: The daemon is running, but its accounting database did not respond. Job accounting records might not be written.

      This field is omitted when the component is healthy.

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

      Returns:
      The reason the component is unhealthy. Valid values:

      • DaemonDown: The daemon is not running, so job accounting records are not being written.

      • DaemonDisabled: The daemon is running and its accounting database is responding, but the daemon is not enabled to start automatically. Job accounting stops the next time the controller node restarts.

      • DbUnreachable: The daemon is running, but its accounting database did not respond. Job accounting records might not be written.

      This field is omitted when the component is healthy.

      See Also:

    • toBuilder

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

    • builder

      public static SlurmHealthMetadata.Builder builder()

    • serializableBuilderClass

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