Skip to content

Update Enhanced client docs #4031

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 23, 2023
Merged

Update Enhanced client docs #4031

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions ...hanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/DynamoDbEnhancedClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ default BatchWriteResult batchWriteItem(Consumer<BatchWriteItemEnhancedRequest.B

/**
* Retrieves multiple items from one or more tables in a single atomic transaction. TransactGetItem is a composite operation
* where the request contains a set of up to 25 get requests, each containing a table reference and a
* where the request contains a set of get requests, each containing a table reference and a
* {@link GetItemEnhancedRequest}. The list of results correspond to the ordering of the request definitions; for example
* the third addGetItem() call on the request builder will match the third result (index 2) of the result.
* <p>
Expand Down Expand Up @@ -297,6 +297,7 @@ default BatchWriteResult batchWriteItem(Consumer<BatchWriteItemEnhancedRequest.B
* MyItem item = results.get(3).getItem(secondItemTable);
* }
* </pre>
* See {@link DynamoDbClient#transactGetItems(Consumer)} to learn more about {@code TransactGetItems}.
*
* @param request A {@link TransactGetItemsEnhancedRequest} containing keys with table references.
* @return a list of {@link Document} with the results.
Expand All @@ -307,7 +308,7 @@ default List<Document> transactGetItems(TransactGetItemsEnhancedRequest request)

/**
* Retrieves multiple items from one or more tables in a single atomic transaction. TransactGetItem is a composite operation
* where the request contains a set of up to 25 get requests, each containing a table reference and a
* where the request contains a set of get requests, each containing a table reference and a
* {@link GetItemEnhancedRequest}. The list of results correspond to the ordering of the request definitions; for example
* the third addGetItem() call on the request builder will match the third result (index 2) of the result.
* <p>
Expand Down Expand Up @@ -336,17 +337,20 @@ default List<Document> transactGetItems(TransactGetItemsEnhancedRequest request)
* MyItem item = results.get(3).getItem(secondItemTable);
* }
* </pre>
* <p>
* See {@link DynamoDbClient#transactGetItems(Consumer)} to learn more about {@code TransactGetItems}.
*
* @param requestConsumer a {@link Consumer} of {@link TransactGetItemsEnhancedRequest} containing keys with table references.
* @return a list of {@link Document} with the results.
*
*/
default List<Document> transactGetItems(Consumer<TransactGetItemsEnhancedRequest.Builder> requestConsumer) {
throw new UnsupportedOperationException();
}

/**
* Writes and/or modifies multiple items from one or more tables in a single atomic transaction. TransactGetItem is a
* composite operation where the request contains a set of up to 25 action requests, each containing a table reference and
* composite operation where the request contains a set of action requests, each containing a table reference and
* one of the following requests:
* <ul>
* <li>Condition check of item - {@link ConditionCheck}</li>
Expand Down Expand Up @@ -384,6 +388,7 @@ default List<Document> transactGetItems(Consumer<TransactGetItemsEnhancedRequest
* .build());
* }
* </pre>
* See {@link DynamoDbClient#transactWriteItems(Consumer)} to learn more about {@code TransactWriteItems}.
*
* @param request A {@link BatchWriteItemEnhancedRequest} containing keys grouped by tables.
*/
Expand All @@ -393,7 +398,7 @@ default Void transactWriteItems(TransactWriteItemsEnhancedRequest request) {

/**
* Writes and/or modifies multiple items from one or more tables in a single atomic transaction. TransactGetItem is a
* composite operation where the request contains a set of up to 25 action requests, each containing a table reference and
* composite operation where the request contains a set of action requests, each containing a table reference and
* one of the following requests:
* <ul>
* <li>Condition check of item - {@link ConditionCheck}</li>
Expand Down Expand Up @@ -427,6 +432,7 @@ default Void transactWriteItems(TransactWriteItemsEnhancedRequest request) {
* .addUpdateItem(secondItemTable, i -> i.item(item4)));
* }
* </pre>
* See {@link DynamoDbClient#transactWriteItems(Consumer)} to learn more about {@code TransactWriteItems}.
*
* @param requestConsumer a {@link Consumer} of {@link TransactWriteItemsEnhancedRequest} containing keys and items grouped
* by tables.
Expand Down