Class PutItemRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.dynamodb.model.DynamoDbRequest
software.amazon.awssdk.services.dynamodb.model.PutItemRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutItemRequest.Builder,PutItemRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutItemRequest extends DynamoDbRequest implements ToCopyableBuilder<PutItemRequest.Builder,PutItemRequest>

Represents the input of a PutItem operation.

  • Method Details

    • tableName

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

      Returns:
      The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

    • hasItem

      public final boolean hasItem()
      For responses, this returns true if the service returned a value for the Item property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • item

      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.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasItem() method.

      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.

      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.

    • hasExpected

      public final boolean hasExpected()
      For responses, this returns true if the service returned a value for the Expected property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • expected

      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.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExpected() method.

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

    • returnValues

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

      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().

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

      See Also:

    • returnValuesAsString

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

      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().

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

      See Also:

    • returnConsumedCapacity

      public final ReturnConsumedCapacity returnConsumedCapacity()
      Returns the value of the ReturnConsumedCapacity property for this object.

      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().

      Returns:
      The value of the ReturnConsumedCapacity property for this object.
      See Also:

    • returnConsumedCapacityAsString

      public final String returnConsumedCapacityAsString()
      Returns the value of the ReturnConsumedCapacity property for this object.

      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().

      Returns:
      The value of the ReturnConsumedCapacity property for this object.
      See Also:

    • returnItemCollectionMetrics

      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().

      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:

    • returnItemCollectionMetricsAsString

      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().

      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:

    • conditionalOperator

      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().

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

    • conditionalOperatorAsString

      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().

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

    • conditionExpression

      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.

      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 Condition Expressions in the Amazon DynamoDB Developer Guide.

    • hasExpressionAttributeNames

      public final boolean hasExpressionAttributeNames()
      For responses, this returns true if the service returned a value for the ExpressionAttributeNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • expressionAttributeNames

      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.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExpressionAttributeNames() method.

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

    • hasExpressionAttributeValues

      public final boolean hasExpressionAttributeValues()
      For responses, this returns true if the service returned a value for the ExpressionAttributeValues property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • expressionAttributeValues

      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.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExpressionAttributeValues() method.

      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 Condition Expressions in the Amazon DynamoDB Developer Guide.

    • returnValuesOnConditionCheckFailure

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

      If the service returns an enum value that is not available in the current SDK version, returnValuesOnConditionCheckFailure will return ReturnValuesOnConditionCheckFailure.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from returnValuesOnConditionCheckFailureAsString().

      Returns:
      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.

      See Also:

    • returnValuesOnConditionCheckFailureAsString

      public final String returnValuesOnConditionCheckFailureAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, returnValuesOnConditionCheckFailure will return ReturnValuesOnConditionCheckFailure.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from returnValuesOnConditionCheckFailureAsString().

      Returns:
      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.

      See Also:

    • 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>
      Specified by:
      toBuilder in class DynamoDbRequest
      Returns:
      a builder for type T

    • builder

      public static PutItemRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.