Package software.amazon.awssdk.enhanced.dynamodb.model

Class UpdateItemEnhancedRequest<T>

java.lang.Object
software.amazon.awssdk.enhanced.dynamodb.model.UpdateItemEnhancedRequest<T>
Type Parameters:
T - The type of the modelled object.
@ThreadSafe public final class UpdateItemEnhancedRequest<T> extends Object
Defines parameters used to update an item to a DynamoDb table using the updateItem() operation (such as DynamoDbTable.updateItem(UpdateItemEnhancedRequest) or DynamoDbAsyncTable.updateItem(UpdateItemEnhancedRequest)).

A valid request object must contain the item that should be written to the table.

  • Method Details

    • builder

      public static <T> UpdateItemEnhancedRequest.Builder<T> builder(Class<? extends T> itemClass)
      Creates a newly initialized builder for the request object.
      Type Parameters:
      T - The type of the modelled object, corresponding to itemClass
      Parameters:
      itemClass - the class that items in this table map to
      Returns:
      a UpdateItemEnhancedRequest builder

    • toBuilder

      public UpdateItemEnhancedRequest.Builder<T> toBuilder()
      Returns a builder initialized with all existing values on the request object.

    • item

      public T item()
      Returns the item for this update operation request.

    • ignoreNulls

      public Boolean ignoreNulls()
      Returns if the update operation should ignore attributes with null values, or false if it has not been set.

    • conditionExpression

      public Expression conditionExpression()
      Returns the condition Expression set on this request object, or null if it doesn't exist.

    • returnConsumedCapacity

      public ReturnConsumedCapacity returnConsumedCapacity()
      Whether to return the capacity consumed by this operation.
      See Also:

    • returnConsumedCapacityAsString

      public String returnConsumedCapacityAsString()
      Whether to return the capacity consumed by this operation.

      Similar to returnConsumedCapacity() but return the value as a string. This is useful in situations where the value is not defined in ReturnConsumedCapacity.

    • returnItemCollectionMetrics

      public ReturnItemCollectionMetrics returnItemCollectionMetrics()
      Whether to return the item collection metrics.
      See Also:

    • returnItemCollectionMetricsAsString

      public String returnItemCollectionMetricsAsString()
      Whether to return the item collection metrics.

      Similar to returnItemCollectionMetrics() but return the value as a string. This is useful in situations where the value is not defined in ReturnItemCollectionMetrics.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object