@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class PutItemRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input of a PutItem
operation.
NOOP
Constructor and Description |
---|
PutItemRequest()
Default constructor for PutItemRequest object.
|
PutItemRequest(String tableName,
Map<String,AttributeValue> item)
Constructs a new PutItemRequest object.
|
PutItemRequest(String tableName,
Map<String,AttributeValue> item,
ReturnValue returnValues)
Constructs a new PutItemRequest object.
|
PutItemRequest(String tableName,
Map<String,AttributeValue> item,
String returnValues)
Constructs a new PutItemRequest object.
|
Modifier and Type | Method and Description |
---|---|
PutItemRequest |
addExpectedEntry(String key,
ExpectedAttributeValue value)
Add a single Expected entry
|
PutItemRequest |
addExpressionAttributeNamesEntry(String key,
String value)
Add a single ExpressionAttributeNames entry
|
PutItemRequest |
addExpressionAttributeValuesEntry(String key,
AttributeValue value)
Add a single ExpressionAttributeValues entry
|
PutItemRequest |
addItemEntry(String key,
AttributeValue value)
Add a single Item entry
|
PutItemRequest |
clearExpectedEntries()
Removes all the entries added into Expected.
|
PutItemRequest |
clearExpressionAttributeNamesEntries()
Removes all the entries added into ExpressionAttributeNames.
|
PutItemRequest |
clearExpressionAttributeValuesEntries()
Removes all the entries added into ExpressionAttributeValues.
|
PutItemRequest |
clearItemEntries()
Removes all the entries added into Item.
|
PutItemRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getConditionalOperator()
This is a legacy parameter.
|
String |
getConditionExpression()
A condition that must be satisfied in order for a conditional
PutItem operation to succeed. |
Map<String,ExpectedAttributeValue> |
getExpected()
This is a legacy parameter.
|
Map<String,String> |
getExpressionAttributeNames()
One or more substitution tokens for attribute names in an expression.
|
Map<String,AttributeValue> |
getExpressionAttributeValues()
One or more values that can be substituted in an expression.
|
Map<String,AttributeValue> |
getItem()
A map of attribute name/value pairs, one for each attribute.
|
String |
getReturnConsumedCapacity() |
String |
getReturnItemCollectionMetrics()
Determines whether item collection metrics are returned.
|
String |
getReturnValues()
Use
ReturnValues if you want to get the item attributes as they appeared before they were updated
with the PutItem request. |
String |
getReturnValuesOnConditionCheckFailure()
An optional parameter that returns the item attributes for a
PutItem operation that failed a
condition check. |
String |
getTableName()
The name of the table to contain the item.
|
int |
hashCode() |
void |
setConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter.
|
void |
setConditionalOperator(String conditionalOperator)
This is a legacy parameter.
|
void |
setConditionExpression(String conditionExpression)
A condition that must be satisfied in order for a conditional
PutItem operation to succeed. |
void |
setExpected(Map<String,ExpectedAttributeValue> expected)
This is a legacy parameter.
|
void |
setExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression.
|
void |
setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
void |
setItem(Map<String,AttributeValue> item)
A map of attribute name/value pairs, one for each attribute.
|
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.
|
void |
setReturnValues(ReturnValue returnValues)
Use
ReturnValues if you want to get the item attributes as they appeared before they were updated
with the PutItem request. |
void |
setReturnValues(String returnValues)
Use
ReturnValues if you want to get the item attributes as they appeared before they were updated
with the PutItem request. |
void |
setReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure)
An optional parameter that returns the item attributes for a
PutItem operation that failed a
condition check. |
void |
setReturnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure)
An optional parameter that returns the item attributes for a
PutItem operation that failed a
condition check. |
void |
setTableName(String tableName)
The name of the table to contain the item.
|
String |
toString()
Returns a string representation of this object.
|
PutItemRequest |
withConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter.
|
PutItemRequest |
withConditionalOperator(String conditionalOperator)
This is a legacy parameter.
|
PutItemRequest |
withConditionExpression(String conditionExpression)
A condition that must be satisfied in order for a conditional
PutItem operation to succeed. |
PutItemRequest |
withExpected(Map<String,ExpectedAttributeValue> expected)
This is a legacy parameter.
|
PutItemRequest |
withExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression.
|
PutItemRequest |
withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
PutItemRequest |
withItem(Map<String,AttributeValue> item)
A map of attribute name/value pairs, one for each attribute.
|
PutItemRequest |
withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) |
PutItemRequest |
withReturnConsumedCapacity(String returnConsumedCapacity) |
PutItemRequest |
withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
Determines whether item collection metrics are returned.
|
PutItemRequest |
withReturnItemCollectionMetrics(String returnItemCollectionMetrics)
Determines whether item collection metrics are returned.
|
PutItemRequest |
withReturnValues(ReturnValue returnValues)
Use
ReturnValues if you want to get the item attributes as they appeared before they were updated
with the PutItem request. |
PutItemRequest |
withReturnValues(String returnValues)
Use
ReturnValues if you want to get the item attributes as they appeared before they were updated
with the PutItem request. |
PutItemRequest |
withReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure)
An optional parameter that returns the item attributes for a
PutItem operation that failed a
condition check. |
PutItemRequest |
withReturnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure)
An optional parameter that returns the item attributes for a
PutItem operation that failed a
condition check. |
PutItemRequest |
withTableName(String tableName)
The name of the table to contain the item.
|
addHandlerContext, 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 PutItemRequest()
public PutItemRequest(String tableName, Map<String,AttributeValue> item)
tableName
- The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the
table in this parameter.item
- A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required;
you can optionally provide other attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
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.
Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item
map is an AttributeValue
object.
public PutItemRequest(String tableName, Map<String,AttributeValue> item, String returnValues)
tableName
- The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the
table in this parameter.item
- A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required;
you can optionally provide other attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
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.
Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item
map is an AttributeValue
object.
returnValues
- Use ReturnValues
if you want to get the item attributes as they appeared before they were
updated with the PutItem
request. For PutItem
, the valid values are:
NONE
- If ReturnValues
is not specified, or if its value is NONE
,
then nothing is returned. (This setting is the default for ReturnValues
.)
ALL_OLD
- If PutItem
overwrote an attribute name-value pair, then the content of
the old item is returned.
The values returned are strongly consistent.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues
parameter is used by several DynamoDB operations; however,
PutItem
does not recognize any values other than NONE
or ALL_OLD
.
public PutItemRequest(String tableName, Map<String,AttributeValue> item, ReturnValue returnValues)
tableName
- The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the
table in this parameter.item
- A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required;
you can optionally provide other attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
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.
Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item
map is an AttributeValue
object.
returnValues
- Use ReturnValues
if you want to get the item attributes as they appeared before they were
updated with the PutItem
request. For PutItem
, the valid values are:
NONE
- If ReturnValues
is not specified, or if its value is NONE
,
then nothing is returned. (This setting is the default for ReturnValues
.)
ALL_OLD
- If PutItem
overwrote an attribute name-value pair, then the content of
the old item is returned.
The values returned are strongly consistent.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues
parameter is used by several DynamoDB operations; however,
PutItem
does not recognize any values other than NONE
or ALL_OLD
.
public void setTableName(String tableName)
The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
tableName
- The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the
table in this parameter.public String getTableName()
The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
public PutItemRequest withTableName(String tableName)
The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
tableName
- The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the
table in this parameter.public Map<String,AttributeValue> getItem()
A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
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.
Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item
map is an AttributeValue
object.
You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
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.
Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item
map is an AttributeValue
object.
public void setItem(Map<String,AttributeValue> item)
A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
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.
Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item
map is an AttributeValue
object.
item
- A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required;
you can optionally provide other attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
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.
Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item
map is an AttributeValue
object.
public PutItemRequest withItem(Map<String,AttributeValue> item)
A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
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.
Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item
map is an AttributeValue
object.
item
- A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required;
you can optionally provide other attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
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.
Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item
map is an AttributeValue
object.
public PutItemRequest addItemEntry(String key, AttributeValue value)
public PutItemRequest clearItemEntries()
public Map<String,ExpectedAttributeValue> getExpected()
This is a legacy parameter. Use ConditionExpression
instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
ConditionExpression
instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.public void setExpected(Map<String,ExpectedAttributeValue> expected)
This is a legacy parameter. Use ConditionExpression
instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
expected
- This is a legacy parameter. Use ConditionExpression
instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.public PutItemRequest withExpected(Map<String,ExpectedAttributeValue> expected)
This is a legacy parameter. Use ConditionExpression
instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
expected
- This is a legacy parameter. Use ConditionExpression
instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.public PutItemRequest addExpectedEntry(String key, ExpectedAttributeValue value)
public PutItemRequest clearExpectedEntries()
public void setReturnValues(String returnValues)
Use ReturnValues
if you want to get the item attributes as they appeared before they were updated
with the PutItem
request. For PutItem
, the valid values are:
NONE
- If ReturnValues
is not specified, or if its value is NONE
, then
nothing is returned. (This setting is the default for ReturnValues
.)
ALL_OLD
- If PutItem
overwrote an attribute name-value pair, then the content of the
old item is returned.
The values returned are strongly consistent.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues
parameter is used by several DynamoDB operations; however, PutItem
does not recognize any values other than NONE
or ALL_OLD
.
returnValues
- Use ReturnValues
if you want to get the item attributes as they appeared before they were
updated with the PutItem
request. For PutItem
, the valid values are:
NONE
- If ReturnValues
is not specified, or if its value is NONE
,
then nothing is returned. (This setting is the default for ReturnValues
.)
ALL_OLD
- If PutItem
overwrote an attribute name-value pair, then the content of
the old item is returned.
The values returned are strongly consistent.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues
parameter is used by several DynamoDB operations; however,
PutItem
does not recognize any values other than NONE
or ALL_OLD
.
ReturnValue
public String getReturnValues()
Use ReturnValues
if you want to get the item attributes as they appeared before they were updated
with the PutItem
request. For PutItem
, the valid values are:
NONE
- If ReturnValues
is not specified, or if its value is NONE
, then
nothing is returned. (This setting is the default for ReturnValues
.)
ALL_OLD
- If PutItem
overwrote an attribute name-value pair, then the content of the
old item is returned.
The values returned are strongly consistent.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues
parameter is used by several DynamoDB operations; however, PutItem
does not recognize any values other than NONE
or ALL_OLD
.
ReturnValues
if you want to get the item attributes as they appeared before they were
updated with the PutItem
request. For PutItem
, the valid values are:
NONE
- If ReturnValues
is not specified, or if its value is NONE
,
then nothing is returned. (This setting is the default for ReturnValues
.)
ALL_OLD
- If PutItem
overwrote an attribute name-value pair, then the content
of the old item is returned.
The values returned are strongly consistent.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues
parameter is used by several DynamoDB operations; however,
PutItem
does not recognize any values other than NONE
or ALL_OLD
.
ReturnValue
public PutItemRequest withReturnValues(String returnValues)
Use ReturnValues
if you want to get the item attributes as they appeared before they were updated
with the PutItem
request. For PutItem
, the valid values are:
NONE
- If ReturnValues
is not specified, or if its value is NONE
, then
nothing is returned. (This setting is the default for ReturnValues
.)
ALL_OLD
- If PutItem
overwrote an attribute name-value pair, then the content of the
old item is returned.
The values returned are strongly consistent.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues
parameter is used by several DynamoDB operations; however, PutItem
does not recognize any values other than NONE
or ALL_OLD
.
returnValues
- Use ReturnValues
if you want to get the item attributes as they appeared before they were
updated with the PutItem
request. For PutItem
, the valid values are:
NONE
- If ReturnValues
is not specified, or if its value is NONE
,
then nothing is returned. (This setting is the default for ReturnValues
.)
ALL_OLD
- If PutItem
overwrote an attribute name-value pair, then the content of
the old item is returned.
The values returned are strongly consistent.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues
parameter is used by several DynamoDB operations; however,
PutItem
does not recognize any values other than NONE
or ALL_OLD
.
ReturnValue
public void setReturnValues(ReturnValue returnValues)
Use ReturnValues
if you want to get the item attributes as they appeared before they were updated
with the PutItem
request. For PutItem
, the valid values are:
NONE
- If ReturnValues
is not specified, or if its value is NONE
, then
nothing is returned. (This setting is the default for ReturnValues
.)
ALL_OLD
- If PutItem
overwrote an attribute name-value pair, then the content of the
old item is returned.
The values returned are strongly consistent.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues
parameter is used by several DynamoDB operations; however, PutItem
does not recognize any values other than NONE
or ALL_OLD
.
returnValues
- Use ReturnValues
if you want to get the item attributes as they appeared before they were
updated with the PutItem
request. For PutItem
, the valid values are:
NONE
- If ReturnValues
is not specified, or if its value is NONE
,
then nothing is returned. (This setting is the default for ReturnValues
.)
ALL_OLD
- If PutItem
overwrote an attribute name-value pair, then the content of
the old item is returned.
The values returned are strongly consistent.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues
parameter is used by several DynamoDB operations; however,
PutItem
does not recognize any values other than NONE
or ALL_OLD
.
ReturnValue
public PutItemRequest withReturnValues(ReturnValue returnValues)
Use ReturnValues
if you want to get the item attributes as they appeared before they were updated
with the PutItem
request. For PutItem
, the valid values are:
NONE
- If ReturnValues
is not specified, or if its value is NONE
, then
nothing is returned. (This setting is the default for ReturnValues
.)
ALL_OLD
- If PutItem
overwrote an attribute name-value pair, then the content of the
old item is returned.
The values returned are strongly consistent.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues
parameter is used by several DynamoDB operations; however, PutItem
does not recognize any values other than NONE
or ALL_OLD
.
returnValues
- Use ReturnValues
if you want to get the item attributes as they appeared before they were
updated with the PutItem
request. For PutItem
, the valid values are:
NONE
- If ReturnValues
is not specified, or if its value is NONE
,
then nothing is returned. (This setting is the default for ReturnValues
.)
ALL_OLD
- If PutItem
overwrote an attribute name-value pair, then the content of
the old item is returned.
The values returned are strongly consistent.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues
parameter is used by several DynamoDB operations; however,
PutItem
does not recognize any values other than NONE
or ALL_OLD
.
ReturnValue
public void setReturnConsumedCapacity(String returnConsumedCapacity)
returnConsumedCapacity
- ReturnConsumedCapacity
public String getReturnConsumedCapacity()
ReturnConsumedCapacity
public PutItemRequest withReturnConsumedCapacity(String returnConsumedCapacity)
returnConsumedCapacity
- ReturnConsumedCapacity
public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
returnConsumedCapacity
- ReturnConsumedCapacity
public PutItemRequest 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 PutItemRequest 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 PutItemRequest 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 void setConditionalOperator(String conditionalOperator)
This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
conditionalOperator
- This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperator
public String getConditionalOperator()
This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperator
public PutItemRequest withConditionalOperator(String conditionalOperator)
This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
conditionalOperator
- This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperator
public void setConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
conditionalOperator
- This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperator
public PutItemRequest withConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
conditionalOperator
- This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperator
public void setConditionExpression(String conditionExpression)
A condition that must be satisfied in order for a conditional PutItem
operation to succeed.
An expression can contain any of the following:
Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
conditionExpression
- A condition that must be satisfied in order for a conditional PutItem
operation to
succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
public String getConditionExpression()
A condition that must be satisfied in order for a conditional PutItem
operation to succeed.
An expression can contain any of the following:
Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
PutItem
operation to
succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
public PutItemRequest withConditionExpression(String conditionExpression)
A condition that must be satisfied in order for a conditional PutItem
operation to succeed.
An expression can contain any of the following:
Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
conditionExpression
- A condition that must be satisfied in order for a conditional PutItem
operation to
succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
public Map<String,String> getExpressionAttributeNames()
One or more substitution tokens for attribute names in an expression. The following are some use cases for using
ExpressionAttributeNames
:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
the complete list of reserved words, see Reserved Words in
the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
ExpressionAttributeNames
:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
ExpressionAttributeNames
:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an
expression. (For the complete list of reserved words, see Reserved
Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the
following for ExpressionAttributeNames
:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
public void setExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression. The following are some use cases for using
ExpressionAttributeNames
:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
the complete list of reserved words, see Reserved Words in
the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
ExpressionAttributeNames
:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
expressionAttributeNames
- One or more substitution tokens for attribute names in an expression. The following are some use cases for
using ExpressionAttributeNames
:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression.
(For the complete list of reserved words, see Reserved
Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the
following for ExpressionAttributeNames
:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
public PutItemRequest withExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression. The following are some use cases for using
ExpressionAttributeNames
:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
the complete list of reserved words, see Reserved Words in
the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
ExpressionAttributeNames
:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
expressionAttributeNames
- One or more substitution tokens for attribute names in an expression. The following are some use cases for
using ExpressionAttributeNames
:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression.
(For the complete list of reserved words, see Reserved
Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the
following for ExpressionAttributeNames
:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
public PutItemRequest addExpressionAttributeNamesEntry(String key, String value)
public PutItemRequest clearExpressionAttributeNamesEntries()
public Map<String,AttributeValue> getExpressionAttributeValues()
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues
as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues
as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
public void setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues
as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
expressionAttributeValues
- One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues
as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
public PutItemRequest withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues
as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
expressionAttributeValues
- One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues
as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
public PutItemRequest addExpressionAttributeValuesEntry(String key, AttributeValue value)
public PutItemRequest clearExpressionAttributeValuesEntries()
public void setReturnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure)
An optional parameter that returns the item attributes for a PutItem
operation that failed a
condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
returnValuesOnConditionCheckFailure
- An optional parameter that returns the item attributes for a PutItem
operation that failed a
condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
ReturnValuesOnConditionCheckFailure
public String getReturnValuesOnConditionCheckFailure()
An optional parameter that returns the item attributes for a PutItem
operation that failed a
condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
PutItem
operation that failed a
condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
ReturnValuesOnConditionCheckFailure
public PutItemRequest withReturnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure)
An optional parameter that returns the item attributes for a PutItem
operation that failed a
condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
returnValuesOnConditionCheckFailure
- An optional parameter that returns the item attributes for a PutItem
operation that failed a
condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
ReturnValuesOnConditionCheckFailure
public void setReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure)
An optional parameter that returns the item attributes for a PutItem
operation that failed a
condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
returnValuesOnConditionCheckFailure
- An optional parameter that returns the item attributes for a PutItem
operation that failed a
condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
ReturnValuesOnConditionCheckFailure
public PutItemRequest withReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure)
An optional parameter that returns the item attributes for a PutItem
operation that failed a
condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
returnValuesOnConditionCheckFailure
- An optional parameter that returns the item attributes for a PutItem
operation that failed a
condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
ReturnValuesOnConditionCheckFailure
public String toString()
toString
in class Object
Object.toString()
public PutItemRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()