@Generated(value="software.amazon.awssdk:codegen") public final class PutItemRequest extends DynamoDbRequest implements ToCopyableBuilder<PutItemRequest.Builder,PutItemRequest>
Represents the input of a PutItem
operation.
Modifier and Type | Class and Description |
---|---|
static interface |
PutItemRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static PutItemRequest.Builder |
builder() |
ConditionalOperator |
conditionalOperator()
This is a legacy parameter.
|
String |
conditionalOperatorAsString()
This is a legacy parameter.
|
String |
conditionExpression()
A condition that must be satisfied in order for a conditional
PutItem operation to succeed. |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
Map<String,ExpectedAttributeValue> |
expected()
This is a legacy parameter.
|
Map<String,String> |
expressionAttributeNames()
One or more substitution tokens for attribute names in an expression.
|
Map<String,AttributeValue> |
expressionAttributeValues()
One or more values that can be substituted in an expression.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasExpected()
Returns true if the Expected property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
boolean |
hasExpressionAttributeNames()
Returns true if the ExpressionAttributeNames property was specified by the sender (it may be empty), or false if
the sender did not specify the value (it will be empty).
|
boolean |
hasExpressionAttributeValues()
Returns true if the ExpressionAttributeValues property was specified by the sender (it may be empty), or false if
the sender did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasItem()
Returns true if the Item property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
Map<String,AttributeValue> |
item()
A map of attribute name/value pairs, one for each attribute.
|
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.
|
ReturnValue |
returnValues()
Use
ReturnValues if you want to get the item attributes as they appeared before they were updated
with the PutItem request. |
String |
returnValuesAsString()
Use
ReturnValues if you want to get the item attributes as they appeared before they were updated
with the PutItem request. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends PutItemRequest.Builder> |
serializableBuilderClass() |
String |
tableName()
The name of the table to contain the item.
|
PutItemRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String tableName()
The name of the table to contain the item.
public final boolean hasItem()
public final 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasItem()
to see if a value was sent in this field.
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 final boolean hasExpected()
public final Map<String,ExpectedAttributeValue> expected()
This is a legacy parameter. Use ConditionExpression
instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasExpected()
to see if a value was sent in this field.
ConditionExpression
instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.public final 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 ReturnValues
parameter is used by several DynamoDB operations; however, PutItem
does not recognize any values other than NONE
or ALL_OLD
.
If the service returns an enum value that is not available in the current SDK version, returnValues
will
return ReturnValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
returnValuesAsString()
.
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 ReturnValues
parameter is used by several DynamoDB operations; however,
PutItem
does not recognize any values other than NONE
or ALL_OLD
.
ReturnValue
public final String returnValuesAsString()
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 ReturnValues
parameter is used by several DynamoDB operations; however, PutItem
does not recognize any values other than NONE
or ALL_OLD
.
If the service returns an enum value that is not available in the current SDK version, returnValues
will
return ReturnValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
returnValuesAsString()
.
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 ReturnValues
parameter is used by several DynamoDB operations; however,
PutItem
does not recognize any values other than NONE
or ALL_OLD
.
ReturnValue
public final 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 final 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 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()
.
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 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()
.
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 final ConditionalOperator conditionalOperator()
This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
If the service returns an enum value that is not available in the current SDK version,
conditionalOperator
will return ConditionalOperator.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from conditionalOperatorAsString()
.
ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperator
public final String conditionalOperatorAsString()
This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
If the service returns an enum value that is not available in the current SDK version,
conditionalOperator
will return ConditionalOperator.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from conditionalOperatorAsString()
.
ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperator
public final 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.
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 final boolean hasExpressionAttributeNames()
public final 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasExpressionAttributeNames()
to see if a value was sent in this field.
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 final boolean hasExpressionAttributeValues()
public final 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasExpressionAttributeValues()
to see if a value was sent in this field.
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.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<PutItemRequest.Builder,PutItemRequest>
toBuilder
in class DynamoDbRequest
public static PutItemRequest.Builder builder()
public static Class<? extends PutItemRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2021. All rights reserved.