Class DatabaseConfigurationMetadata

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

Metadata information about a change to the external Slurm accounting database of a HyperPod cluster.

See Also:

  • Method Details

    • rollbackStatus

      public final DatabaseConfigurationRollbackStatus rollbackStatus()

      Whether HyperPod restored the previous accounting database configuration after the change failed. Valid values:

      • NotApplicable: The change failed before HyperPod modified the cluster, for example because the database could not be reached or rejected the credentials, so there was nothing to restore.

      • Reverted: The change failed after it was applied, and HyperPod restored the previous configuration. The cluster continues to use the previous accounting database.

      • RevertFailed: The change failed and HyperPod could not restore the previous configuration, so Slurm accounting on the cluster might not be working.

      This field is omitted when the change succeeds.

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

      Returns:
      Whether HyperPod restored the previous accounting database configuration after the change failed. Valid values:

      • NotApplicable: The change failed before HyperPod modified the cluster, for example because the database could not be reached or rejected the credentials, so there was nothing to restore.

      • Reverted: The change failed after it was applied, and HyperPod restored the previous configuration. The cluster continues to use the previous accounting database.

      • RevertFailed: The change failed and HyperPod could not restore the previous configuration, so Slurm accounting on the cluster might not be working.

      This field is omitted when the change succeeds.

      See Also:

    • rollbackStatusAsString

      public final String rollbackStatusAsString()

      Whether HyperPod restored the previous accounting database configuration after the change failed. Valid values:

      • NotApplicable: The change failed before HyperPod modified the cluster, for example because the database could not be reached or rejected the credentials, so there was nothing to restore.

      • Reverted: The change failed after it was applied, and HyperPod restored the previous configuration. The cluster continues to use the previous accounting database.

      • RevertFailed: The change failed and HyperPod could not restore the previous configuration, so Slurm accounting on the cluster might not be working.

      This field is omitted when the change succeeds.

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

      Returns:
      Whether HyperPod restored the previous accounting database configuration after the change failed. Valid values:

      • NotApplicable: The change failed before HyperPod modified the cluster, for example because the database could not be reached or rejected the credentials, so there was nothing to restore.

      • Reverted: The change failed after it was applied, and HyperPod restored the previous configuration. The cluster continues to use the previous accounting database.

      • RevertFailed: The change failed and HyperPod could not restore the previous configuration, so Slurm accounting on the cluster might not be working.

      This field is omitted when the change succeeds.

      See Also:

    • advisory

      public final String advisory()

      Additional information about a change that succeeded, such as an action to take on the cluster.

      Returns:
      Additional information about a change that succeeded, such as an action to take on the cluster.

    • failureMessage

      public final String failureMessage()

      An error message describing why the accounting database change failed, and how to resolve it.

      Returns:
      An error message describing why the accounting database change failed, and how to resolve it.

    • toBuilder

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

    • builder

      public static DatabaseConfigurationMetadata.Builder builder()

    • serializableBuilderClass

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