From c015a19518941d36f3e85ddfc96714d2d95e66c3 Mon Sep 17 00:00:00 2001 From: Dongie Agnir <261310+dagnir@users.noreply.github.com> Date: Tue, 23 May 2023 16:22:30 -0700 Subject: [PATCH] Update Enhanced client docs (#4031) The docs for transactGetItems and transactWriteItems contained outdated information regarding the max number of items. This makes the doc a bit more generic by not specifying the max number, and linking to the low-level client docs for more information. --- .../enhanced/dynamodb/DynamoDbEnhancedClient.java | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/DynamoDbEnhancedClient.java b/services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/DynamoDbEnhancedClient.java index 256cd3e9fdba..5c2448a985d7 100644 --- a/services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/DynamoDbEnhancedClient.java +++ b/services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/DynamoDbEnhancedClient.java @@ -269,7 +269,7 @@ default BatchWriteResult batchWriteItem(Consumer @@ -297,6 +297,7 @@ default BatchWriteResult batchWriteItem(Consumer + * 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. @@ -307,7 +308,7 @@ default List 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. *

@@ -336,9 +337,12 @@ default List transactGetItems(TransactGetItemsEnhancedRequest request) * MyItem item = results.get(3).getItem(secondItemTable); * } * + *

+ * 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 transactGetItems(Consumer requestConsumer) { throw new UnsupportedOperationException(); @@ -346,7 +350,7 @@ default List transactGetItems(Consumer *

  • Condition check of item - {@link ConditionCheck}
  • @@ -384,6 +388,7 @@ default List transactGetItems(Consumer + * See {@link DynamoDbClient#transactWriteItems(Consumer)} to learn more about {@code TransactWriteItems}. * * @param request A {@link BatchWriteItemEnhancedRequest} containing keys grouped by tables. */ @@ -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: *
      *
    • Condition check of item - {@link ConditionCheck}
    • @@ -427,6 +432,7 @@ default Void transactWriteItems(TransactWriteItemsEnhancedRequest request) { * .addUpdateItem(secondItemTable, i -> i.item(item4))); * } * + * 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.