Class ComputeQuotaSummary

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

Summary of the compute allocation definition.

See Also:

  • Method Details

    • computeQuotaArn

      public final String computeQuotaArn()

      ARN of the compute allocation definition.

      Returns:
      ARN of the compute allocation definition.

    • computeQuotaId

      public final String computeQuotaId()

      ID of the compute allocation definition.

      Returns:
      ID of the compute allocation definition.

    • name

      public final String name()

      Name of the compute allocation definition.

      Returns:
      Name of the compute allocation definition.

    • computeQuotaVersion

      public final Integer computeQuotaVersion()

      Version of the compute allocation definition.

      Returns:
      Version of the compute allocation definition.

    • status

      public final SchedulerResourceStatus status()

      Status of the compute allocation definition.

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

      Returns:
      Status of the compute allocation definition.
      See Also:

    • statusAsString

      public final String statusAsString()

      Status of the compute allocation definition.

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

      Returns:
      Status of the compute allocation definition.
      See Also:

    • clusterArn

      public final String clusterArn()

      ARN of the cluster.

      Returns:
      ARN of the cluster.

    • computeQuotaConfig

      public final ComputeQuotaConfig computeQuotaConfig()

      Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks.

      Returns:
      Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks.

    • computeQuotaTarget

      public final ComputeQuotaTarget computeQuotaTarget()

      The target entity to allocate compute resources to.

      Returns:
      The target entity to allocate compute resources to.

    • activationState

      public final ActivationState activationState()

      The state of the compute allocation being described. Use to enable or disable compute allocation.

      Default is Enabled.

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

      Returns:
      The state of the compute allocation being described. Use to enable or disable compute allocation.

      Default is Enabled.

      See Also:

    • activationStateAsString

      public final String activationStateAsString()

      The state of the compute allocation being described. Use to enable or disable compute allocation.

      Default is Enabled.

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

      Returns:
      The state of the compute allocation being described. Use to enable or disable compute allocation.

      Default is Enabled.

      See Also:

    • creationTime

      public final Instant creationTime()

      Creation time of the compute allocation definition.

      Returns:
      Creation time of the compute allocation definition.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      Last modified time of the compute allocation definition.

      Returns:
      Last modified time of the compute allocation definition.

    • toBuilder

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

    • builder

      public static ComputeQuotaSummary.Builder builder()

    • serializableBuilderClass

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