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>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeConsumableResourceResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Long`	`availableQuantity()`	The amount of the consumable resource that is currently available to use.
`static DescribeConsumableResourceResponse.Builder`	`builder()`
`String`	`consumableResourceArn()`	The Amazon Resource Name (ARN) of the consumable resource.
`String`	`consumableResourceName()`	The name of the consumable resource.
`Long`	`createdAt()`	The Unix timestamp (in milliseconds) for when the consumable resource was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`Long`	`inUseQuantity()`	The amount of the consumable resource that is currently in use.
`String`	`resourceType()`	Indicates whether the resource is available to be re-used after a job completes.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeConsumableResourceResponse.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()`	The tags that you apply to the consumable resource to help you categorize and organize your resources.
`DescribeConsumableResourceResponse.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Long`	`totalQuantity()`	The total amount of the consumable resource that is available.

Methods inherited from class software.amazon.awssdk.services.batch.model.BatchResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeConsumableResourceResponse.Builder,DescribeConsumableResourceResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class DescribeConsumableResourceResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.batch.model.BatchResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

consumableResourceName

consumableResourceArn

totalQuantity

inUseQuantity

availableQuantity

resourceType

createdAt

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField