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

Class CreateConsumableResourceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.batch.model.BatchRequest

software.amazon.awssdk.services.batch.model.CreateConsumableResourceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateConsumableResourceRequest.Builder,CreateConsumableResourceRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateConsumableResourceRequest
extends BatchRequest
implements ToCopyableBuilder<CreateConsumableResourceRequest.Builder,CreateConsumableResourceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateConsumableResourceRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateConsumableResourceRequest.Builder	builder()
String	consumableResourceName()	The name of the consumable resource.
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.
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 CreateConsumableResourceRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	The tags that you apply to the consumable resource to help you categorize and organize your resources.
CreateConsumableResourceRequest.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.awscore.AwsRequest

overrideConfiguration

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. Must be unique.

Returns:

The name of the consumable resource. Must be unique.

totalQuantity

public final Long totalQuantity()

The total amount of the consumable resource that is available. Must be non-negative.

Returns:

The total amount of the consumable resource that is available. Must be non-negative.

resourceType

public final String resourceType()

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

• REPLENISHABLE (default)

• NON_REPLENISHABLE

Returns:

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

• REPLENISHABLE (default)

• NON_REPLENISHABLE

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 CreateConsumableResourceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateConsumableResourceRequest.Builder,CreateConsumableResourceRequest>

Specified by:

toBuilder in class BatchRequest

builder

public static CreateConsumableResourceRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

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