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

Class UpdateConsumableResourceRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateConsumableResourceRequest.Builder,UpdateConsumableResourceRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateConsumableResourceRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateConsumableResourceRequest.Builder	builder()
String	clientToken()	If this parameter is specified and two update requests with identical payloads and clientTokens are received, these requests are considered the same request and the second request is rejected.
String	consumableResource()	The name or ARN of the consumable resource to be updated.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	operation()	Indicates how the quantity of the consumable resource will be updated.
Long	quantity()	The change in the total quantity of the consumable resource.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateConsumableResourceRequest.Builder>	serializableBuilderClass()
UpdateConsumableResourceRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

consumableResource

public final String consumableResource()

The name or ARN of the consumable resource to be updated.

Returns:

The name or ARN of the consumable resource to be updated.

operation

public final String operation()

Indicates how the quantity of the consumable resource will be updated. Must be one of:

• SET

  Sets the quantity of the resource to the value specified by the quantity parameter.

• ADD

  Increases the quantity of the resource by the value specified by the quantity parameter.

• REMOVE

  Reduces the quantity of the resource by the value specified by the quantity parameter.

Returns:

Indicates how the quantity of the consumable resource will be updated. Must be one of:

• SET

  Sets the quantity of the resource to the value specified by the quantity parameter.

• ADD

  Increases the quantity of the resource by the value specified by the quantity parameter.

• REMOVE

  Reduces the quantity of the resource by the value specified by the quantity parameter.

quantity

public final Long quantity()

The change in the total quantity of the consumable resource. The operation parameter determines whether the value specified here will be the new total quantity, or the amount by which the total quantity will be increased or reduced. Must be a non-negative value.

Returns:

The change in the total quantity of the consumable resource. The operation parameter determines whether the value specified here will be the new total quantity, or the amount by which the total quantity will be increased or reduced. Must be a non-negative value.

clientToken

public final String clientToken()

If this parameter is specified and two update requests with identical payloads and clientTokens are received, these requests are considered the same request and the second request is rejected. A clientToken is valid for 8 hours or until one hour after the consumable resource is deleted, whichever is less.

Returns:

If this parameter is specified and two update requests with identical payloads and clientTokens are received, these requests are considered the same request and the second request is rejected. A clientToken is valid for 8 hours or until one hour after the consumable resource is deleted, whichever is less.

toBuilder

public UpdateConsumableResourceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateConsumableResourceRequest.Builder,UpdateConsumableResourceRequest>

Specified by:

toBuilder in class BatchRequest

builder

public static UpdateConsumableResourceRequest.Builder builder()

serializableBuilderClass

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