Package software.amazon.awssdk.services.dynamodb.model

Class PutItemRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.dynamodb.model.PutItemRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<PutItemRequest.Builder,PutItemRequest>

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

Represents the input of a PutItem operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutItemRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static PutItemRequest.Builder	builder()
String	conditionalOperator()	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)
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.
int	hashCode()
Map<String,AttributeValue>	item()	A map of attribute name/value pairs, one for each attribute.
String	returnConsumedCapacity()
String	returnItemCollectionMetrics()	Determines whether item collection metrics are returned.
String	returnValues()	Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request.
static Class<? extends PutItemRequest.Builder>	serializableBuilderClass()
String	tableName()	The name of the table to contain the item.
PutItemRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

tableName

public String tableName()

The name of the table to contain the item.

Returns:

The name of the table to contain the item.

item

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

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.

Returns:

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.

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.

expected

public Map<String,ExpectedAttributeValue> expected()

This is a legacy parameter. Use ConditionExpresssion instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

Returns:

This is a legacy parameter. Use ConditionExpresssion instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

returnValues

public 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 ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD.

Returns:

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.

See Also:

ReturnValue

returnConsumedCapacity

public String returnConsumedCapacity()

Returns:

See Also:

ReturnConsumedCapacity

returnItemCollectionMetrics

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

Returns:

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

See Also:

ReturnItemCollectionMetrics

conditionalOperator

public String conditionalOperator()

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

Returns:

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

See Also:

ConditionalOperator

conditionExpression

public 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 Specifying Conditions in the Amazon DynamoDB Developer Guide.

Returns:

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 Specifying Conditions in the Amazon DynamoDB Developer Guide.

expressionAttributeNames

public 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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Returns:

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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

expressionAttributeValues

public 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 Specifying Conditions in the Amazon DynamoDB Developer Guide.

Returns:

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 Specifying Conditions in the Amazon DynamoDB Developer Guide.

toBuilder

public PutItemRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PutItemRequest.Builder,PutItemRequest>

Returns:

a builder for type T

builder

public static PutItemRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutItemRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object