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.
aws · May 23, 2023 · c015a19 · c015a19
1 parent f611a86
commit c015a19
Showing 1 changed file with 10 additions and 4 deletions.
diff --git a/...hanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/DynamoDbEnhancedClient.java b/...hanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/DynamoDbEnhancedClient.java
@@ -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>
@@ -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.
@@ -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>
@@ -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>
@@ -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.
      */
@@ -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>
@@ -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.