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

Interface TransactWriteItemsRequest.Builder

    • Method Detail

      • transactItems

        TransactWriteItemsRequest.Builder transactItems​(Collection<TransactWriteItem> transactItems)

        An ordered array of up to 100 TransactWriteItem objects, each of which contains a ConditionCheck, Put, Update, or Delete object. These can operate on items in different tables, but the tables must reside in the same Amazon Web Services account and Region, and no two of them can operate on the same item.

        Parameters:
        transactItems - An ordered array of up to 100 TransactWriteItem objects, each of which contains a ConditionCheck, Put, Update, or Delete object. These can operate on items in different tables, but the tables must reside in the same Amazon Web Services account and Region, and no two of them can operate on the same item.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • transactItems

        TransactWriteItemsRequest.Builder transactItems​(TransactWriteItem... transactItems)

        An ordered array of up to 100 TransactWriteItem objects, each of which contains a ConditionCheck, Put, Update, or Delete object. These can operate on items in different tables, but the tables must reside in the same Amazon Web Services account and Region, and no two of them can operate on the same item.

        Parameters:
        transactItems - An ordered array of up to 100 TransactWriteItem objects, each of which contains a ConditionCheck, Put, Update, or Delete object. These can operate on items in different tables, but the tables must reside in the same Amazon Web Services account and Region, and no two of them can operate on the same item.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • transactItems

        TransactWriteItemsRequest.Builder transactItems​(Consumer<TransactWriteItem.Builder>... transactItems)

        An ordered array of up to 100 TransactWriteItem objects, each of which contains a ConditionCheck, Put, Update, or Delete object. These can operate on items in different tables, but the tables must reside in the same Amazon Web Services account and Region, and no two of them can operate on the same item.

        This is a convenience method that creates an instance of the TransactWriteItem.Builder avoiding the need to create one manually via TransactWriteItem.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #transactItems(List).

        Parameters:
        transactItems - a consumer that will call methods on TransactWriteItem.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #transactItems(java.util.Collection)

      • returnConsumedCapacity

        TransactWriteItemsRequest.Builder returnConsumedCapacity​(String returnConsumedCapacity)
        Sets the value of the ReturnConsumedCapacity property for this object.
        Parameters:
        returnConsumedCapacity - The new value for the ReturnConsumedCapacity property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ReturnConsumedCapacity, ReturnConsumedCapacity

      • returnItemCollectionMetrics

        TransactWriteItemsRequest.Builder returnItemCollectionMetrics​(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 and are returned in the response. If set to NONE (the default), no statistics are returned.

        Parameters:
        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 and are returned in the response. If set to NONE (the default), no statistics are returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ReturnItemCollectionMetrics, ReturnItemCollectionMetrics

      • returnItemCollectionMetrics

        TransactWriteItemsRequest.Builder returnItemCollectionMetrics​(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 and are returned in the response. If set to NONE (the default), no statistics are returned.

        Parameters:
        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 and are returned in the response. If set to NONE (the default), no statistics are returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ReturnItemCollectionMetrics, ReturnItemCollectionMetrics

      • clientRequestToken

        TransactWriteItemsRequest.Builder clientRequestToken​(String clientRequestToken)

        Providing a ClientRequestToken makes the call to TransactWriteItems idempotent, meaning that multiple identical calls have the same effect as one single call.

        Although multiple identical calls using the same client request token produce the same result on the server (no side effects), the responses to the calls might not be the same. If the ReturnConsumedCapacity parameter is set, then the initial TransactWriteItems call returns the amount of write capacity units consumed in making the changes. Subsequent TransactWriteItems calls with the same client token return the number of read capacity units consumed in reading the item.

        A client request token is valid for 10 minutes after the first request that uses it is completed. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes, or the result might not be idempotent.

        If you submit a request with the same client token but a change in other parameters within the 10-minute idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.

        Parameters:
        clientRequestToken - Providing a ClientRequestToken makes the call to TransactWriteItems idempotent, meaning that multiple identical calls have the same effect as one single call.

        Although multiple identical calls using the same client request token produce the same result on the server (no side effects), the responses to the calls might not be the same. If the ReturnConsumedCapacity parameter is set, then the initial TransactWriteItems call returns the amount of write capacity units consumed in making the changes. Subsequent TransactWriteItems calls with the same client token return the number of read capacity units consumed in reading the item.

        A client request token is valid for 10 minutes after the first request that uses it is completed. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes, or the result might not be idempotent.

        If you submit a request with the same client token but a change in other parameters within the 10-minute idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.

        Returns:
        Returns a reference to this object so that method calls can be chained together.