Class QuotaShareDetail

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

Detailed information about a quota share, including its configuration, state, and capacity limits.

See Also:

  • Method Details

    • quotaShareName

      public final String quotaShareName()

      The name of the quota share.

      Returns:
      The name of the quota share.

    • quotaShareArn

      public final String quotaShareArn()

      The Amazon Resource Name (ARN) of the quota share.

      Returns:
      The Amazon Resource Name (ARN) of the quota share.

    • jobQueueArn

      public final String jobQueueArn()

      The Amazon Resource Name (ARN) of the job queue associated with the quota share.

      Returns:
      The Amazon Resource Name (ARN) of the job queue associated with the quota share.

    • hasCapacityLimits

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

    • capacityLimits

      public final List<QuotaShareCapacityLimit> capacityLimits()

      A list that specifies the quantity and type of compute capacity allocated to the quota share.

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

      Returns:
      A list that specifies the quantity and type of compute capacity allocated to the quota share.

    • resourceSharingConfiguration

      public final QuotaShareResourceSharingConfiguration resourceSharingConfiguration()

      Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.

      Returns:
      Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.

    • preemptionConfiguration

      public final QuotaSharePreemptionConfiguration preemptionConfiguration()

      Specifies the preemption behavior for jobs in a quota share.

      Returns:
      Specifies the preemption behavior for jobs in a quota share.

    • state

      public final QuotaShareState state()

      The state of the quota share.

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

      Returns:
      The state of the quota share.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the quota share.

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

      Returns:
      The state of the quota share.
      See Also:

    • status

      public final QuotaShareStatus status()

      The current status of the quota share.

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

      Returns:
      The current status of the quota share.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the quota share.

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

      Returns:
      The current status of the quota share.
      See Also:

    • toBuilder

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

    • builder

      public static QuotaShareDetail.Builder builder()

    • serializableBuilderClass

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