@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class BatchWriteItemRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input of a BatchWriteItem
operation.
NOOP
Constructor and Description |
---|
BatchWriteItemRequest()
Default constructor for BatchWriteItemRequest object.
|
BatchWriteItemRequest(Map<String,List<WriteRequest>> requestItems)
Constructs a new BatchWriteItemRequest object.
|
Modifier and Type | Method and Description |
---|---|
BatchWriteItemRequest |
addRequestItemsEntry(String key,
List<WriteRequest> value)
Add a single RequestItems entry
|
BatchWriteItemRequest |
clearRequestItemsEntries()
Removes all the entries added into RequestItems.
|
BatchWriteItemRequest |
clone() |
boolean |
equals(Object obj) |
Map<String,List<WriteRequest>> |
getRequestItems()
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 ). |
String |
getReturnConsumedCapacity() |
String |
getReturnItemCollectionMetrics()
Determines whether item collection metrics are returned.
|
int |
hashCode() |
void |
setRequestItems(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 ). |
void |
setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) |
void |
setReturnConsumedCapacity(String returnConsumedCapacity) |
void |
setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
Determines whether item collection metrics are returned.
|
void |
setReturnItemCollectionMetrics(String returnItemCollectionMetrics)
Determines whether item collection metrics are returned.
|
String |
toString()
Returns a string representation of this object.
|
BatchWriteItemRequest |
withRequestItems(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 ). |
BatchWriteItemRequest |
withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) |
BatchWriteItemRequest |
withReturnConsumedCapacity(String returnConsumedCapacity) |
BatchWriteItemRequest |
withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
Determines whether item collection metrics are returned.
|
BatchWriteItemRequest |
withReturnItemCollectionMetrics(String returnItemCollectionMetrics)
Determines whether item collection metrics are returned.
|
addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public BatchWriteItemRequest()
public BatchWriteItemRequest(Map<String,List<WriteRequest>> requestItems)
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.
public Map<String,List<WriteRequest>> getRequestItems()
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.
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.
public void setRequestItems(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.
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.
public BatchWriteItemRequest withRequestItems(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.
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.
public BatchWriteItemRequest addRequestItemsEntry(String key, List<WriteRequest> value)
public BatchWriteItemRequest clearRequestItemsEntries()
public void setReturnConsumedCapacity(String returnConsumedCapacity)
returnConsumedCapacity
- ReturnConsumedCapacity
public String getReturnConsumedCapacity()
ReturnConsumedCapacity
public BatchWriteItemRequest withReturnConsumedCapacity(String returnConsumedCapacity)
returnConsumedCapacity
- ReturnConsumedCapacity
public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
returnConsumedCapacity
- ReturnConsumedCapacity
public BatchWriteItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
returnConsumedCapacity
- ReturnConsumedCapacity
public void setReturnItemCollectionMetrics(String 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.
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.ReturnItemCollectionMetrics
public String getReturnItemCollectionMetrics()
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.
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 withReturnItemCollectionMetrics(String 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.
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.ReturnItemCollectionMetrics
public void setReturnItemCollectionMetrics(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.
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.ReturnItemCollectionMetrics
public BatchWriteItemRequest withReturnItemCollectionMetrics(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.
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.ReturnItemCollectionMetrics
public String toString()
toString
in class Object
Object.toString()
public BatchWriteItemRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2024. All rights reserved.