Package software.amazon.awssdk.services.batch.model

Class ShareAttributes

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

Specifies the weights for the fair share identifiers for the fair share policy. Fair share identifiers that aren't included have a default weight of 1.0.

See Also:

  • Method Details

    • shareIdentifier

      public final String shareIdentifier()

      A fair share identifier or fair share identifier prefix. If the string ends with an asterisk (*), this entry specifies the weight factor to use for fair share identifiers that start with that prefix. The list of fair share identifiers in a fair share policy can't overlap. For example, you can't have one that specifies a shareIdentifier of UserA* and another that specifies a shareIdentifier of UserA-1.

      There can be no more than 500 fair share identifiers active in a job queue.

      The string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).

      Returns:
      A fair share identifier or fair share identifier prefix. If the string ends with an asterisk (*), this entry specifies the weight factor to use for fair share identifiers that start with that prefix. The list of fair share identifiers in a fair share policy can't overlap. For example, you can't have one that specifies a shareIdentifier of UserA* and another that specifies a shareIdentifier of UserA-1.

      There can be no more than 500 fair share identifiers active in a job queue.

      The string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).

    • weightFactor

      public final Float weightFactor()

      The weight factor for the fair share identifier. The default value is 1.0. A lower value has a higher priority for compute resources. For example, jobs that use a share identifier with a weight factor of 0.125 (1/8) get 8 times the compute resources of jobs that use a share identifier with a weight factor of 1.

      The smallest supported value is 0.0001, and the largest supported value is 999.9999.

      Returns:
      The weight factor for the fair share identifier. The default value is 1.0. A lower value has a higher priority for compute resources. For example, jobs that use a share identifier with a weight factor of 0.125 (1/8) get 8 times the compute resources of jobs that use a share identifier with a weight factor of 1.

      The smallest supported value is 0.0001, and the largest supported value is 999.9999.

    • toBuilder

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

    • builder

      public static ShareAttributes.Builder builder()

    • serializableBuilderClass

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