Class ClusterOperationSummary

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

A summary of an operation performed on a HyperPod cluster.

See Also:

  • Method Details

    • operationId

      public final String operationId()

      The unique identifier (UUID) of the operation.

      Returns:
      The unique identifier (UUID) of the operation.

    • clusterArn

      public final String clusterArn()

      The Amazon Resource Name (ARN) of the HyperPod cluster associated with the operation.

      Returns:
      The Amazon Resource Name (ARN) of the HyperPod cluster associated with the operation.

    • type

      public final ClusterOperationType type()

      The type of the operation. Valid values are Scaling or DeepHealthCheck.

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

      Returns:
      The type of the operation. Valid values are Scaling or DeepHealthCheck.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the operation. Valid values are Scaling or DeepHealthCheck.

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

      Returns:
      The type of the operation. Valid values are Scaling or DeepHealthCheck.
      See Also:

    • status

      public final ClusterOperationStatus status()

      The current status of the operation. Valid values are InProgress, Superseded, or Done.

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

      Returns:
      The current status of the operation. Valid values are InProgress, Superseded, or Done.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the operation. Valid values are InProgress, Superseded, or Done.

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

      Returns:
      The current status of the operation. Valid values are InProgress, Superseded, or Done.
      See Also:

    • creationTime

      public final Instant creationTime()

      The timestamp when the operation was created.

      Returns:
      The timestamp when the operation was created.

    • toBuilder

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

    • builder

      public static ClusterOperationSummary.Builder builder()

    • serializableBuilderClass

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