Class ExtensionDetails

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

Details of an extension installed on a SageMaker HyperPod cluster.

See Also:

  • Method Details

    • clusterArn

      public final String clusterArn()

      The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster on which the extension is installed.

      Returns:
      The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster on which the extension is installed.

    • extensionArn

      public final String extensionArn()

      The Amazon Resource Name (ARN) of the extension.

      Returns:
      The Amazon Resource Name (ARN) of the extension.

    • extensionName

      public final String extensionName()

      The name of the extension.

      Returns:
      The name of the extension.

    • extensionVersion

      public final String extensionVersion()

      The version of the extension. While SageMaker HyperPod creates or updates the extension, some nodes might still run a different version. To see how many nodes run this version, see NodeSummary.

      Returns:
      The version of the extension. While SageMaker HyperPod creates or updates the extension, some nodes might still run a different version. To see how many nodes run this version, see NodeSummary.

    • status

      public final ExtensionStatus status()

      The status of the extension can be one of the following values:

      Creating

      SageMaker HyperPod is installing the extension on the cluster's nodes.

      Active

      The extension runs its current version and configuration on all of the cluster's nodes.

      Updating

      SageMaker HyperPod is applying a configuration change or version update to the cluster's nodes.

      Degraded

      The extension runs its current version and configuration on some of the cluster's nodes but not all of them. Or, at least one node recently reported that the extension is unhealthy.

      CreateFailed

      SageMaker HyperPod couldn't install the extension on any of the cluster's nodes.

      UpdateFailed

      SageMaker HyperPod couldn't apply the update on any of the cluster's nodes.

      Deleting

      SageMaker HyperPod is removing the extension from the cluster's nodes.

      DeleteFailed

      SageMaker HyperPod couldn't remove the extension from any of the cluster's nodes.

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

      Returns:
      The status of the extension can be one of the following values:

      Creating

      SageMaker HyperPod is installing the extension on the cluster's nodes.

      Active

      The extension runs its current version and configuration on all of the cluster's nodes.

      Updating

      SageMaker HyperPod is applying a configuration change or version update to the cluster's nodes.

      Degraded

      The extension runs its current version and configuration on some of the cluster's nodes but not all of them. Or, at least one node recently reported that the extension is unhealthy.

      CreateFailed

      SageMaker HyperPod couldn't install the extension on any of the cluster's nodes.

      UpdateFailed

      SageMaker HyperPod couldn't apply the update on any of the cluster's nodes.

      Deleting

      SageMaker HyperPod is removing the extension from the cluster's nodes.

      DeleteFailed

      SageMaker HyperPod couldn't remove the extension from any of the cluster's nodes.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the extension can be one of the following values:

      Creating

      SageMaker HyperPod is installing the extension on the cluster's nodes.

      Active

      The extension runs its current version and configuration on all of the cluster's nodes.

      Updating

      SageMaker HyperPod is applying a configuration change or version update to the cluster's nodes.

      Degraded

      The extension runs its current version and configuration on some of the cluster's nodes but not all of them. Or, at least one node recently reported that the extension is unhealthy.

      CreateFailed

      SageMaker HyperPod couldn't install the extension on any of the cluster's nodes.

      UpdateFailed

      SageMaker HyperPod couldn't apply the update on any of the cluster's nodes.

      Deleting

      SageMaker HyperPod is removing the extension from the cluster's nodes.

      DeleteFailed

      SageMaker HyperPod couldn't remove the extension from any of the cluster's nodes.

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

      Returns:
      The status of the extension can be one of the following values:

      Creating

      SageMaker HyperPod is installing the extension on the cluster's nodes.

      Active

      The extension runs its current version and configuration on all of the cluster's nodes.

      Updating

      SageMaker HyperPod is applying a configuration change or version update to the cluster's nodes.

      Degraded

      The extension runs its current version and configuration on some of the cluster's nodes but not all of them. Or, at least one node recently reported that the extension is unhealthy.

      CreateFailed

      SageMaker HyperPod couldn't install the extension on any of the cluster's nodes.

      UpdateFailed

      SageMaker HyperPod couldn't apply the update on any of the cluster's nodes.

      Deleting

      SageMaker HyperPod is removing the extension from the cluster's nodes.

      DeleteFailed

      SageMaker HyperPod couldn't remove the extension from any of the cluster's nodes.

      See Also:

    • configurationValues

      public final String configurationValues()

      The configuration of the extension, as a JSON object serialized as a string. The configuration includes the default value of every setting that you didn't specify.

      Returns:
      The configuration of the extension, as a JSON object serialized as a string. The configuration includes the default value of every setting that you didn't specify.

    • creationTime

      public final Instant creationTime()

      The time when the extension was created.

      Returns:
      The time when the extension was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The time when the extension was last updated.

      Returns:
      The time when the extension was last updated.

    • toBuilder

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

    • builder

      public static ExtensionDetails.Builder builder()

    • serializableBuilderClass

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