Class ClusterSummary

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

Lists a summary of the properties of a SageMaker HyperPod cluster.

See Also:

  • Method Details

    • clusterArn

      public final String clusterArn()

      The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

      Returns:
      The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

    • clusterName

      public final String clusterName()

      The name of the SageMaker HyperPod cluster.

      Returns:
      The name of the SageMaker HyperPod cluster.

    • creationTime

      public final Instant creationTime()

      The time when the SageMaker HyperPod cluster is created.

      Returns:
      The time when the SageMaker HyperPod cluster is created.

    • clusterStatus

      public final ClusterStatus clusterStatus()

      The status of the SageMaker HyperPod cluster.

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

      Returns:
      The status of the SageMaker HyperPod cluster.
      See Also:

    • clusterStatusAsString

      public final String clusterStatusAsString()

      The status of the SageMaker HyperPod cluster.

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

      Returns:
      The status of the SageMaker HyperPod cluster.
      See Also:

    • hasTrainingPlanArns

      public final boolean hasTrainingPlanArns()
      For responses, this returns true if the service returned a value for the TrainingPlanArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • trainingPlanArns

      public final List<String> trainingPlanArns()

      A list of Amazon Resource Names (ARNs) of the training plans associated with this cluster.

      For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTrainingPlanArns() method.

      Returns:
      A list of Amazon Resource Names (ARNs) of the training plans associated with this cluster.

      For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

    • toBuilder

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

    • builder

      public static ClusterSummary.Builder builder()

    • serializableBuilderClass

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