Interface UpdateItemApi

  • All Known Implementing Classes:
    Table

    public interface UpdateItemApi
    A Table-centric UpdateItem API.
    • Method Detail

      • updateItem

        UpdateItemOutcome updateItem​(PrimaryKey primaryKey,
                                     AttributeUpdate... attributeUpdates)
        Updates an item with the attributes specified.
        Parameters:
        primaryKey - primary key of the item to be updated
        attributeUpdates - attributes to be updated
      • updateItem

        UpdateItemOutcome updateItem​(PrimaryKey primaryKey,
                                     Collection<Expected> expected,
                                     AttributeUpdate... attributeUpdates)
        Updates an item with the attributes specified.
        Parameters:
        primaryKey - primary key of the item to be updated
        expected - the condition to match for the update to succeed.
        attributeUpdates - attributes to be updated
      • updateItem

        UpdateItemOutcome updateItem​(PrimaryKey primaryKey,
                                     String updateExpression,
                                     Map<String,​String> nameMap,
                                     Map<String,​Object> valueMap)
        Performs an update on an item in the table using the given update expression string.
        Parameters:
        primaryKey - primary key of the item to be updated
        updateExpression - the update expression that specifies the attributes to be updated.
        nameMap - the map containing the mapping between attribute names used in update expression and the actual name of the attributes
        valueMap - the map containing the mapping between the attribute value used in update expression and the actual value of the attribute
      • updateItem

        UpdateItemOutcome updateItem​(PrimaryKey primaryKey,
                                     String updateExpression,
                                     String conditionExpression,
                                     Map<String,​String> nameMap,
                                     Map<String,​Object> valueMap)
        Updates an item with the specified primary key using the given update expression provided the condition expression evaluates to true.
        Parameters:
        primaryKey - primary key of the item to be updated
        updateExpression - the update expression that specifies the attributes to be updated.
        conditionExpression - the condition expression that specifies the condition that needs to be evaluated to true
        nameMap - the map containing the mapping between attribute names used in update and condition expression and the actual name of the attributes
        valueMap - the map containing the mapping between the attribute value used in update and condition expression and the actual value of the attribute
      • updateItem

        UpdateItemOutcome updateItem​(UpdateItemSpec updateItemSpec)
        Performs an update on an item in the table by specifying all the details.
        Parameters:
        updateItemSpec - the update specification for the item to be updated.