Class ResourceSharingConfig

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

Resource sharing configuration.

See Also:

  • Method Details

    • strategy

      public final ResourceSharingStrategy strategy()

      The strategy of how idle compute is shared within the cluster. The following are the options of strategies.

      • DontLend: entities do not lend idle compute.

      • Lend: entities can lend idle compute to entities that can borrow.

      • LendandBorrow: entities can lend idle compute and borrow idle compute from other entities.

      Default is LendandBorrow.

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

      Returns:
      The strategy of how idle compute is shared within the cluster. The following are the options of strategies.

      • DontLend: entities do not lend idle compute.

      • Lend: entities can lend idle compute to entities that can borrow.

      • LendandBorrow: entities can lend idle compute and borrow idle compute from other entities.

      Default is LendandBorrow.

      See Also:

    • strategyAsString

      public final String strategyAsString()

      The strategy of how idle compute is shared within the cluster. The following are the options of strategies.

      • DontLend: entities do not lend idle compute.

      • Lend: entities can lend idle compute to entities that can borrow.

      • LendandBorrow: entities can lend idle compute and borrow idle compute from other entities.

      Default is LendandBorrow.

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

      Returns:
      The strategy of how idle compute is shared within the cluster. The following are the options of strategies.

      • DontLend: entities do not lend idle compute.

      • Lend: entities can lend idle compute to entities that can borrow.

      • LendandBorrow: entities can lend idle compute and borrow idle compute from other entities.

      Default is LendandBorrow.

      See Also:

    • borrowLimit

      public final Integer borrowLimit()

      The limit on how much idle compute can be borrowed.The values can be 1 - 500 percent of idle compute that the team is allowed to borrow.

      Default is 50.

      Returns:
      The limit on how much idle compute can be borrowed.The values can be 1 - 500 percent of idle compute that the team is allowed to borrow.

      Default is 50.

    • hasAbsoluteBorrowLimits

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

    • absoluteBorrowLimits

      public final List<ComputeQuotaResourceConfig> absoluteBorrowLimits()

      The absolute limits on compute resources that can be borrowed from idle compute. When specified, these limits define the maximum amount of specific resource types (such as accelerators, vCPU, or memory) that an entity can borrow, regardless of the percentage-based BorrowLimit.

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

      Returns:
      The absolute limits on compute resources that can be borrowed from idle compute. When specified, these limits define the maximum amount of specific resource types (such as accelerators, vCPU, or memory) that an entity can borrow, regardless of the percentage-based BorrowLimit.

    • toBuilder

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

    • builder

      public static ResourceSharingConfig.Builder builder()

    • serializableBuilderClass

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