@Generated(value="software.amazon.awssdk:codegen") public final class BatchWriteItemRequest extends DynamoDbRequest implements ToCopyableBuilder<BatchWriteItemRequest.Builder,BatchWriteItemRequest>
Represents the input of a BatchWriteItem
operation.
Modifier and Type | Class and Description |
---|---|
static interface |
BatchWriteItemRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static BatchWriteItemRequest.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
Map<String,List<WriteRequest>> |
requestItems()
A map of one or more table names 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.
|
static Class<? extends BatchWriteItemRequest.Builder> |
serializableBuilderClass() |
BatchWriteItemRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public Map<String,List<WriteRequest>> requestItems()
A map of one or more table names 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 will be 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.
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 will be 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.
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 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 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 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 are returned
in the response. If set to NONE
(the default), no statistics are returned.ReturnItemCollectionMetrics
public BatchWriteItemRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<BatchWriteItemRequest.Builder,BatchWriteItemRequest>
toBuilder
in class DynamoDbRequest
public static BatchWriteItemRequest.Builder builder()
public static Class<? extends BatchWriteItemRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. 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, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.