Class ClusterSummary

java.lang.Object
software.amazon.awssdk.services.pcs.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>

The object returned by the ListClusters API action.

See Also:

  • Method Details

    • name

      public final String name()

      The name that identifies the cluster.

      Returns:
      The name that identifies the cluster.

    • id

      public final String id()

      The generated unique ID of the cluster.

      Returns:
      The generated unique ID of the cluster.

    • arn

      public final String arn()

      The unique Amazon Resource Name (ARN) of the cluster.

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

    • createdAt

      public final Instant createdAt()

      The date and time the resource was created.

      Returns:
      The date and time the resource was created.

    • modifiedAt

      public final Instant modifiedAt()

      The date and time the resource was modified.

      Returns:
      The date and time the resource was modified.

    • status

      public final ClusterStatus status()

      The provisioning status of the cluster.

      The provisioning status doesn't indicate the overall health of the cluster.

      The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.

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

      Returns:
      The provisioning status of the cluster.

      The provisioning status doesn't indicate the overall health of the cluster.

      The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.

      See Also:

    • statusAsString

      public final String statusAsString()

      The provisioning status of the cluster.

      The provisioning status doesn't indicate the overall health of the cluster.

      The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.

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

      Returns:
      The provisioning status of the cluster.

      The provisioning status doesn't indicate the overall health of the cluster.

      The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.

      See Also:

    • 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.