Class UpdateConsumableResourceRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateConsumableResourceRequest.Builder,
UpdateConsumableResourceRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
If this parameter is specified and two update requests with identical payloads andclientToken
s are received, these requests are considered the same request and the second request is rejected.final String
The name or ARN of the consumable resource to be updated.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
Indicates how the quantity of the consumable resource will be updated.final Long
quantity()
The change in the total quantity of the consumable resource.static Class
<? extends UpdateConsumableResourceRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
If this parameter is specified and two update requests with identical payloads and
clientToken
s are received, these requests are considered the same request and the second request is rejected. AclientToken
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
clientToken
s are received, these requests are considered the same request and the second request is rejected. AclientToken
is valid for 8 hours or until one hour after the consumable resource is deleted, whichever is less.
-
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 interfaceToCopyableBuilder<UpdateConsumableResourceRequest.Builder,
UpdateConsumableResourceRequest> - Specified by:
toBuilder
in classBatchRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-