Fix Javadocs on async paginators

Author: zoewangg

.changes/next-release/bugfix-AWSSDKforJavav2-135b2d9.json

@@ -0,0 +1,5 @@
+{
+    "category": "AWS SDK for Java v2", 
+    "type": "bugfix", 
+    "description": "Fix async pagination javadocs to use the correct method name `SdkPublisher#subscribe`."
+}

codegen/src/main/java/software/amazon/awssdk/codegen/docs/PaginationDocs.java

@@ -163,13 +163,13 @@ private String getAsyncCodeSnippets() {
 
         return CodeBlock.builder()
                         .add("\n\n<p>The following are few ways to use the response class:</p>")
-                        .add("1) Using the forEach helper method",
+                        .add("1) Using the subscribe helper method",
                              TypeName.get(SequentialSubscriber.class))
                         .add(buildCode(CodeBlock.builder()
                                                 .add(callOperationOnClient)
                                                 .add(CodeBlock.builder()
                                                               .addStatement("CompletableFuture<Void> future = publisher"
-                                                                            + ".forEach(res -> "
+                                                                            + ".subscribe(res -> "
                                                                             + "{ // Do something with the response })")
                                                               .addStatement("future.get()")
                                                               .build())

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-async-client-class.java

@@ -451,12 +451,12 @@ public CompletableFuture<PaginatedOperationWithResultKeyResponse> paginatedOpera
      * <p>
      * The following are few ways to use the response class:
      * </p>
-     * 1) Using the forEach helper method
+     * 1) Using the subscribe helper method
      *
      * <pre>
      * {@code
      * software.amazon.awssdk.services.json.paginators.PaginatedOperationWithResultKeyPublisher publisher = client.paginatedOperationWithResultKeyPaginator(request);
-     * CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
+     * CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
      * future.get();
      * }
      * </pre>
@@ -567,12 +567,12 @@ public CompletableFuture<PaginatedOperationWithoutResultKeyResponse> paginatedOp
      * <p>
      * The following are few ways to use the response class:
      * </p>
-     * 1) Using the forEach helper method
+     * 1) Using the subscribe helper method
      *
      * <pre>
      * {@code
      * software.amazon.awssdk.services.json.paginators.PaginatedOperationWithoutResultKeyPublisher publisher = client.paginatedOperationWithoutResultKeyPaginator(request);
-     * CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
+     * CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
      * future.get();
      * }
      * </pre>
@@ -824,4 +824,3 @@ private HttpResponseHandler<AwsServiceException> createErrorResponseHandler(Base
         return protocolFactory.createErrorResponseHandler(operationMetadata);
     }
 }
-

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-json-async-client-interface.java

@@ -490,12 +490,12 @@ default CompletableFuture<PaginatedOperationWithResultKeyResponse> paginatedOper
      * <p>
      * The following are few ways to use the response class:
      * </p>
-     * 1) Using the forEach helper method
+     * 1) Using the subscribe helper method
      *
      * <pre>
      * {@code
      * software.amazon.awssdk.services.json.paginators.PaginatedOperationWithResultKeyPublisher publisher = client.paginatedOperationWithResultKeyPaginator(request);
-     * CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
+     * CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
      * future.get();
      * }
      * </pre>
@@ -561,12 +561,12 @@ default PaginatedOperationWithResultKeyPublisher paginatedOperationWithResultKey
      * <p>
      * The following are few ways to use the response class:
      * </p>
-     * 1) Using the forEach helper method
+     * 1) Using the subscribe helper method
      *
      * <pre>
      * {@code
      * software.amazon.awssdk.services.json.paginators.PaginatedOperationWithResultKeyPublisher publisher = client.paginatedOperationWithResultKeyPaginator(request);
-     * CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
+     * CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
      * future.get();
      * }
      * </pre>
@@ -634,12 +634,12 @@ default PaginatedOperationWithResultKeyPublisher paginatedOperationWithResultKey
      * <p>
      * The following are few ways to use the response class:
      * </p>
-     * 1) Using the forEach helper method
+     * 1) Using the subscribe helper method
      *
      * <pre>
      * {@code
      * software.amazon.awssdk.services.json.paginators.PaginatedOperationWithResultKeyPublisher publisher = client.paginatedOperationWithResultKeyPaginator(request);
-     * CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
+     * CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
      * future.get();
      * }
      * </pre>
@@ -771,12 +771,12 @@ default CompletableFuture<PaginatedOperationWithoutResultKeyResponse> paginatedO
      * <p>
      * The following are few ways to use the response class:
      * </p>
-     * 1) Using the forEach helper method
+     * 1) Using the subscribe helper method
      *
      * <pre>
      * {@code
      * software.amazon.awssdk.services.json.paginators.PaginatedOperationWithoutResultKeyPublisher publisher = client.paginatedOperationWithoutResultKeyPaginator(request);
-     * CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
+     * CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
      * future.get();
      * }
      * </pre>
@@ -844,12 +844,12 @@ default PaginatedOperationWithoutResultKeyPublisher paginatedOperationWithoutRes
      * <p>
      * The following are few ways to use the response class:
      * </p>
-     * 1) Using the forEach helper method
+     * 1) Using the subscribe helper method
      *
      * <pre>
      * {@code
      * software.amazon.awssdk.services.json.paginators.PaginatedOperationWithoutResultKeyPublisher publisher = client.paginatedOperationWithoutResultKeyPaginator(request);
-     * CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
+     * CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
      * future.get();
      * }
      * </pre>

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/paginators/PaginatedOperationWithResultKeyPublisher.java

@@ -38,12 +38,12 @@
  * <p>
  * The following are few ways to use the response class:
  * </p>
- * 1) Using the forEach helper method
+ * 1) Using the subscribe helper method
  *
  * <pre>
  * {@code
  * software.amazon.awssdk.services.jsonprotocoltests.paginators.PaginatedOperationWithResultKeyPublisher publisher = client.paginatedOperationWithResultKeyPaginator(request);
- * CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
+ * CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
  * future.get();
  * }
  * </pre>

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/paginators/PaginatedOperationWithoutResultKeyPublisher.java

@@ -33,12 +33,12 @@
  * <p>
  * The following are few ways to use the response class:
  * </p>
- * 1) Using the forEach helper method
+ * 1) Using the subscribe helper method
  *
  * <pre>
  * {@code
  * software.amazon.awssdk.services.jsonprotocoltests.paginators.PaginatedOperationWithoutResultKeyPublisher publisher = client.paginatedOperationWithoutResultKeyPaginator(request);
- * CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
+ * CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
  * future.get();
  * }
  * </pre>