@Generated(value="software.amazon.awssdk:codegen") public final class TransactWriteItemsRequest extends DynamoDbRequest implements ToCopyableBuilder<TransactWriteItemsRequest.Builder,TransactWriteItemsRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
TransactWriteItemsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static TransactWriteItemsRequest.Builder |
builder() |
String |
clientRequestToken()
Providing a
ClientRequestToken makes the call to TransactWriteItems idempotent, meaning
that multiple identical calls have the same effect as one single call. |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
ReturnConsumedCapacity |
returnConsumedCapacity()
Returns the value of the ReturnConsumedCapacity property for this object.
|
String |
returnConsumedCapacityAsString()
Returns the value of the ReturnConsumedCapacity property for this object.
|
ReturnItemCollectionMetrics |
returnItemCollectionMetrics()
Determines whether item collection metrics are returned.
|
String |
returnItemCollectionMetricsAsString()
Determines whether item collection metrics are returned.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends TransactWriteItemsRequest.Builder> |
serializableBuilderClass() |
TransactWriteItemsRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
List<TransactWriteItem> |
transactItems()
An ordered array of up to 10
TransactWriteItem objects, each of which contains a
ConditionCheck , Put , Update , or Delete object. |
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public List<TransactWriteItem> transactItems()
An ordered array of up to 10 TransactWriteItem
objects, each of which contains a
ConditionCheck
, Put
, Update
, or Delete
object. These can
operate on items in different tables, but the tables must reside in the same AWS account and region, and no two
of them can operate on the same item.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
TransactWriteItem
objects, each of which contains a
ConditionCheck
, Put
, Update
, or Delete
object. These
can operate on items in different tables, but the tables must reside in the same AWS account and region,
and no two of them can operate on the same item.public ReturnConsumedCapacity returnConsumedCapacity()
If the service returns an enum value that is not available in the current SDK version,
returnConsumedCapacity
will return ReturnConsumedCapacity.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from returnConsumedCapacityAsString()
.
ReturnConsumedCapacity
public String returnConsumedCapacityAsString()
If the service returns an enum value that is not available in the current SDK version,
returnConsumedCapacity
will return ReturnConsumedCapacity.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from returnConsumedCapacityAsString()
.
ReturnConsumedCapacity
public ReturnItemCollectionMetrics returnItemCollectionMetrics()
Determines whether item collection metrics are returned. If set to SIZE
, the response includes
statistics about item collections (if any), that were modified during the operation and are returned in the
response. If set to NONE
(the default), no statistics are returned.
If the service returns an enum value that is not available in the current SDK version,
returnItemCollectionMetrics
will return ReturnItemCollectionMetrics.UNKNOWN_TO_SDK_VERSION
. The
raw value returned by the service is available from returnItemCollectionMetricsAsString()
.
SIZE
, the response
includes statistics about item collections (if any), that were modified during the operation and are
returned in the response. If set to NONE
(the default), no statistics are returned.ReturnItemCollectionMetrics
public String returnItemCollectionMetricsAsString()
Determines whether item collection metrics are returned. If set to SIZE
, the response includes
statistics about item collections (if any), that were modified during the operation and are returned in the
response. If set to NONE
(the default), no statistics are returned.
If the service returns an enum value that is not available in the current SDK version,
returnItemCollectionMetrics
will return ReturnItemCollectionMetrics.UNKNOWN_TO_SDK_VERSION
. The
raw value returned by the service is available from returnItemCollectionMetricsAsString()
.
SIZE
, the response
includes statistics about item collections (if any), that were modified during the operation and are
returned in the response. If set to NONE
(the default), no statistics are returned.ReturnItemCollectionMetrics
public String clientRequestToken()
Providing a ClientRequestToken
makes the call to TransactWriteItems
idempotent, meaning
that multiple identical calls have the same effect as one single call.
Although multiple identical calls using the same client request token produce the same result on the server (no
side effects), the responses to the calls may not be the same. If the ReturnConsumedCapacity>
parameter is set, then the initial TransactWriteItems
call returns the amount of write capacity
units consumed in making the changes, and subsequent TransactWriteItems
calls with the same client
token return the amount of read capacity units consumed in reading the item.
A client request token is valid for 10 minutes after the first request that uses it completes. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes or the result may not be idempotent.
If you submit a request with the same client token but a change in other parameters within the 10 minute
idempotency window, DynamoDB returns an IdempotentParameterMismatch
exception.
ClientRequestToken
makes the call to TransactWriteItems
idempotent,
meaning that multiple identical calls have the same effect as one single call.
Although multiple identical calls using the same client request token produce the same result on the
server (no side effects), the responses to the calls may not be the same. If the
ReturnConsumedCapacity>
parameter is set, then the initial
TransactWriteItems
call returns the amount of write capacity units consumed in making the
changes, and subsequent TransactWriteItems
calls with the same client token return the
amount of read capacity units consumed in reading the item.
A client request token is valid for 10 minutes after the first request that uses it completes. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes or the result may not be idempotent.
If you submit a request with the same client token but a change in other parameters within the 10 minute
idempotency window, DynamoDB returns an IdempotentParameterMismatch
exception.
public TransactWriteItemsRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<TransactWriteItemsRequest.Builder,TransactWriteItemsRequest>
toBuilder
in class DynamoDbRequest
public static TransactWriteItemsRequest.Builder builder()
public static Class<? extends TransactWriteItemsRequest.Builder> serializableBuilderClass()
public String toString()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2019. All rights reserved.