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

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

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

Represents the input of a BatchWriteItem operation.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface BatchWriteItemRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static BatchWriteItemRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasRequestItems()`	For responses, this returns true if the service returned a value for the RequestItems property.
`Map<String,List<WriteRequest>>`	`requestItems()`	A map of one or more table names or table ARNs and, for each table, a list of operations to be performed ( `DeleteRequest` or `PutRequest`).
`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.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends BatchWriteItemRequest.Builder>`	`serializableBuilderClass()`
`BatchWriteItemRequest.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
  - hasRequestItems
```
public final boolean hasRequestItems()
```
    For responses, this returns true if the service returned a value for the RequestItems 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.
  - requestItems
```
public final Map<String,List<WriteRequest>> requestItems()
```
    A map of one or more table names or table ARNs and, for each table, a list of operations to be performed ( DeleteRequest or PutRequest). Each element in the map consists of the following:
    
    DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:
    
    Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
    
    PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:
    
    Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values are rejected with a ValidationException exception.
    
    If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
    
    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 hasRequestItems() method.
    Returns:
    
    A map of one or more table names or table ARNs and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following:
    
    DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:
    
    Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
    
    PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:
    
    Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values are rejected with a ValidationException exception.
    
    If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
  - 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 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 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 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 are returned in the response. If set to NONE (the default), no statistics are returned.
    
    See Also:
    
    ReturnItemCollectionMetrics
  - toBuilder
```
public BatchWriteItemRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<BatchWriteItemRequest.Builder,BatchWriteItemRequest>
    
    Specified by:
    
    toBuilder in class DynamoDbRequest
  - builder
```
public static BatchWriteItemRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends BatchWriteItemRequest.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

Class BatchWriteItemRequest

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

hasRequestItems

requestItems

returnConsumedCapacity

returnConsumedCapacityAsString

returnItemCollectionMetrics

returnItemCollectionMetricsAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField