Class DescribeConsumableResourceResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.batch.model.BatchResponse
software.amazon.awssdk.services.batch.model.DescribeConsumableResourceResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeConsumableResourceResponse.Builder,DescribeConsumableResourceResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeConsumableResourceResponse extends BatchResponse implements ToCopyableBuilder<DescribeConsumableResourceResponse.Builder,DescribeConsumableResourceResponse>

  • Method Details

    • consumableResourceName

      public final String consumableResourceName()

      The name of the consumable resource.

      Returns:
      The name of the consumable resource.

    • consumableResourceArn

      public final String consumableResourceArn()

      The Amazon Resource Name (ARN) of the consumable resource.

      Returns:
      The Amazon Resource Name (ARN) of the consumable resource.

    • totalQuantity

      public final Long totalQuantity()

      The total amount of the consumable resource that is available.

      Returns:
      The total amount of the consumable resource that is available.

    • inUseQuantity

      public final Long inUseQuantity()

      The amount of the consumable resource that is currently in use.

      Returns:
      The amount of the consumable resource that is currently in use.

    • availableQuantity

      public final Long availableQuantity()

      The amount of the consumable resource that is currently available to use.

      Returns:
      The amount of the consumable resource that is currently available to use.

    • resourceType

      public final String resourceType()

      Indicates whether the resource is available to be re-used after a job completes. Can be one of:

      • REPLENISHABLE

      • NON_REPLENISHABLE

      Returns:
      Indicates whether the resource is available to be re-used after a job completes. Can be one of:

      • REPLENISHABLE

      • NON_REPLENISHABLE

    • createdAt

      public final Long createdAt()

      The Unix timestamp (in milliseconds) for when the consumable resource was created.

      Returns:
      The Unix timestamp (in milliseconds) for when the consumable resource was created.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      The tags that you apply to the consumable resource to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.

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

      Returns:
      The tags that you apply to the consumable resource to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.

    • toBuilder

      public DescribeConsumableResourceResponse.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<DescribeConsumableResourceResponse.Builder,DescribeConsumableResourceResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeConsumableResourceResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeConsumableResourceResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.