updated Hello example

awsdocs · Feb 7, 2025 · 82feea2 · 82feea2
1 parent aec45c7
commit 82feea2
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 14 deletions.
diff --git a/.doc_gen/metadata/entityresolution_metadata.yaml b/.doc_gen/metadata/entityresolution_metadata.yaml
@@ -121,4 +121,31 @@ entityresolution_CreateSchemaMapping:
               snippet_tags:
                 - entityres.java2_create_schema.main
   services:
-    entityresolution: {CreateSchemaMapping}
+    entityresolution: {CreateSchemaMapping}
+entityresolution_Scenario:
+  synopsis_list:
+    - Create Schema Mapping.
+    - Create an &ERlong; workflow.
+    - Start the matching job for the workflow.
+    - Get details for the matching job.
+    - Get Schema Mapping.
+    - List all Schema Mappings.
+    - Tag the Schema Mapping resource.
+    - Delete the AWS Entity Resolution Workflow.
+    - Delete the &ERlong; Assets.
+  category: Basics
+  languages:
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/entityresolution
+          sdkguide:
+          excerpts:
+            - description: Run an interactive scenario demonstrating &ERlong; features.
+              snippet_tags:
+                - entityres.java2_scenario.main
+            - description: A wrapper class for &ITSW; SDK methods.
+              snippet_tags:
+                - iotsitewise.java2.actions.main 
+  services:
+    iotsitewise: {}    
diff --git a/...example_code/entityresolution/src/main/java/com/example/entity/HelloEntityResoultion.java b/...example_code/entityresolution/src/main/java/com/example/entity/HelloEntityResoultion.java
@@ -3,7 +3,6 @@
 
 package com.example.entity;
 
-import com.example.entity.scenario.EntityResScenario;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration;
@@ -12,21 +11,20 @@
 import software.amazon.awssdk.http.nio.netty.NettyNioAsyncHttpClient;
 import software.amazon.awssdk.regions.Region;
 import software.amazon.awssdk.services.entityresolution.EntityResolutionAsyncClient;
-import software.amazon.awssdk.services.entityresolution.model.GetIdMappingWorkflowRequest;
-import software.amazon.awssdk.services.entityresolution.model.GetIdMappingWorkflowResponse;
-import software.amazon.awssdk.services.entityresolution.model.ListIdMappingJobsRequest;
 import software.amazon.awssdk.services.entityresolution.model.ListMatchingWorkflowsRequest;
-import software.amazon.awssdk.services.entityresolution.model.ListMatchingWorkflowsResponse;
-import software.amazon.awssdk.services.entityresolution.model.ListSchemaMappingsRequest;
-import software.amazon.awssdk.services.entityresolution.model.ResourceNotFoundException;
-import software.amazon.awssdk.services.entityresolution.paginators.ListIdMappingJobsPublisher;
 import software.amazon.awssdk.services.entityresolution.paginators.ListMatchingWorkflowsPublisher;
-import software.amazon.awssdk.services.entityresolution.paginators.ListSchemaMappingsPublisher;
-
 import java.time.Duration;
 import java.util.concurrent.CompletableFuture;
 
 // snippet-start:[entityres.java2_hello.main]
+/**
+ * Before running this Java V2 code example, set up your development
+ * environment, including your credentials.
+ *
+ * For more information, see the following documentation topic:
+ *
+ * https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
+ */
 public class HelloEntityResoultion {
 
     private static final Logger logger = LoggerFactory.getLogger(HelloEntityResoultion.class);
@@ -65,9 +63,17 @@ public static EntityResolutionAsyncClient getResolutionAsyncClient() {
                 .build();
         }
         return entityResolutionAsyncClient;
-
     }
 
+    /**
+     * Lists all matching workflows using an asynchronous paginator.
+     * <p>
+     * This method requests a paginated list of matching workflows from the
+     * AWS Entity Resolution service and logs the names of the retrieved workflows.
+     * It uses an asynchronous approach with a paginator and waits for the operation
+     * to complete using {@code CompletableFuture#join()}.
+     * </p>
+     */
     public static void listMatchingWorkflows() {
         ListMatchingWorkflowsRequest request = ListMatchingWorkflowsRequest.builder().build();
 

diff --git a/...ple_code/entityresolution/src/main/java/com/example/entity/scenario/EntityResActions.java b/...ple_code/entityresolution/src/main/java/com/example/entity/scenario/EntityResActions.java
@@ -41,6 +41,7 @@
 import java.util.Map;
 import java.util.concurrent.CompletableFuture;
 
+// snippet-start:[entityres.java2_actions.main]
 public class EntityResActions {
     private static final Logger logger = LoggerFactory.getLogger(EntityResActions.class);
 
@@ -412,3 +413,4 @@ public boolean doesObjectExist(String bucketName) {
         }
     }
 }
+// snippet-end:[entityres.java2_actions.main]
diff --git a/...le_code/entityresolution/src/main/java/com/example/entity/scenario/EntityResScenario.java b/...le_code/entityresolution/src/main/java/com/example/entity/scenario/EntityResScenario.java
@@ -11,6 +11,7 @@
 import java.util.Scanner;
 import java.util.concurrent.CompletionException;
 
+// snippet-start:[entityres.java2_scenario.main]
 public class EntityResScenario {
     private static final Logger logger = LoggerFactory.getLogger(EntityResScenario.class);
     public static final String DASHES = new String(new char[80]).replace("\0", "-");
@@ -289,5 +290,5 @@ public static void countdownWithWorkflowCheck(EntityResActions actions, int tota
             }
         }
     }
-
-}
+}
+// snippet-end:[entityres.java2_scenario.main]