Class Put

java.lang.Object
software.amazon.awssdk.services.dynamodb.model.Put
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Put.Builder,Put>
@Generated("software.amazon.awssdk:codegen") public final class Put extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Put.Builder,Put>

Represents a request to perform a PutItem operation.

See Also:

  • Method Details

    • 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 to attribute values, representing the primary key of the item to be written by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item that are part of an index key schema for the table, their types must match the index key schema.

      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 to attribute values, representing the primary key of the item to be written by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item that are part of an index key schema for the table, their types must match the index key schema.

    • tableName

      public final String tableName()

      Name of the table in which to write the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

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

    • conditionExpression

      public final String conditionExpression()

      A condition that must be satisfied in order for a conditional update to succeed.

      Returns:
      A condition that must be satisfied in order for a conditional update to succeed.

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

      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.

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

      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.

    • returnValuesOnConditionCheckFailure

      public final ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure()

      Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Put condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.

      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:
      Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Put condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.
      See Also:

    • returnValuesOnConditionCheckFailureAsString

      public final String returnValuesOnConditionCheckFailureAsString()

      Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Put condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.

      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:
      Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Put condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.
      See Also:

    • toBuilder

      public Put.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<Put.Builder,Put>
      Returns:
      a builder for type T

    • builder

      public static Put.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.