Class ComputeQuotaConfig

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

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

See Also:

  • Method Details

    • hasComputeQuotaResources

      public final boolean hasComputeQuotaResources()
      For responses, this returns true if the service returned a value for the ComputeQuotaResources 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.

    • computeQuotaResources

      public final List<ComputeQuotaResourceConfig> computeQuotaResources()

      Allocate compute resources by instance types.

      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 hasComputeQuotaResources() method.

      Returns:
      Allocate compute resources by instance types.

    • resourceSharingConfig

      public final ResourceSharingConfig resourceSharingConfig()

      Resource sharing configuration. This defines how an entity can lend and borrow idle compute with other entities within the cluster.

      Returns:
      Resource sharing configuration. This defines how an entity can lend and borrow idle compute with other entities within the cluster.

    • preemptTeamTasks

      public final PreemptTeamTasks preemptTeamTasks()

      Allows workloads from within an entity to preempt same-team workloads. When set to LowerPriority, the entity's lower priority tasks are preempted by their own higher priority tasks.

      Default is LowerPriority.

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

      Returns:
      Allows workloads from within an entity to preempt same-team workloads. When set to LowerPriority, the entity's lower priority tasks are preempted by their own higher priority tasks.

      Default is LowerPriority.

      See Also:

    • preemptTeamTasksAsString

      public final String preemptTeamTasksAsString()

      Allows workloads from within an entity to preempt same-team workloads. When set to LowerPriority, the entity's lower priority tasks are preempted by their own higher priority tasks.

      Default is LowerPriority.

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

      Returns:
      Allows workloads from within an entity to preempt same-team workloads. When set to LowerPriority, the entity's lower priority tasks are preempted by their own higher priority tasks.

      Default is LowerPriority.

      See Also:

    • toBuilder

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

    • builder

      public static ComputeQuotaConfig.Builder builder()

    • serializableBuilderClass

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