java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.dynamodb.model.DynamoDbRequest
    - - software.amazon.awssdk.services.dynamodb.model.TransactWriteItemsRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<TransactWriteItemsRequest.Builder,TransactWriteItemsRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface TransactWriteItemsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTransactItems()`	For responses, this returns true if the service returned a value for the TransactItems property.
`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 100 `TransactWriteItem` objects, each of which contains a `ConditionCheck`, `Put`, `Update`, or `Delete` 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
  - hasTransactItems
```
public final boolean hasTransactItems()
```
    For responses, this returns true if the service returned a value for the TransactItems 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.
  - transactItems
```
public final List<TransactWriteItem> transactItems()
```
    An ordered array of up to 100 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 Amazon Web Services 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.
    
    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 hasTransactItems() method.
    
    Returns:
    
    An ordered array of up to 100 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 Amazon Web Services account and Region, and no two of them can operate on the same item.
  - returnConsumedCapacity
```
public final ReturnConsumedCapacity returnConsumedCapacity()
```
    Returns the value of the ReturnConsumedCapacity property for this object.
    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().
    
    Returns:
    
    The value of the ReturnConsumedCapacity property for this object.
    
    See Also:
    
    ReturnConsumedCapacity
  - returnConsumedCapacityAsString
```
public final String returnConsumedCapacityAsString()
```
    Returns the value of the ReturnConsumedCapacity property for this object.
    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().
    
    Returns:
    
    The value of the ReturnConsumedCapacity property for this object.
    
    See Also:
    
    ReturnConsumedCapacity
  - returnItemCollectionMetrics
```
public final 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().
    
    Returns:
    
    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.
    
    See Also:
    
    ReturnItemCollectionMetrics
  - returnItemCollectionMetricsAsString
```
public final 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().
    
    Returns:
    
    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.
    
    See Also:
    
    ReturnItemCollectionMetrics
  - clientRequestToken
```
public final 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 might 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. Subsequent TransactWriteItems calls with the same client token return the number 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 is completed. 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 might 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.
    
    Returns:
    
    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 might 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. Subsequent TransactWriteItems calls with the same client token return the number 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 is completed. 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 might 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.
  - toBuilder
```
public TransactWriteItemsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TransactWriteItemsRequest.Builder,TransactWriteItemsRequest>
    
    Specified by:
    
    toBuilder in class DynamoDbRequest
  - builder
```
public static TransactWriteItemsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends TransactWriteItemsRequest.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

Class TransactWriteItemsRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

hasTransactItems

transactItems

returnConsumedCapacity

returnConsumedCapacityAsString

returnItemCollectionMetrics

returnItemCollectionMetricsAsString

clientRequestToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields