added SOS

Author: scmacdon

.doc_gen/metadata/neptune_metadata.yaml

@@ -0,0 +1,14 @@
+# zexi 0.4.0
+neptune_Hello:
+  languages:
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/neptune
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - neptune.java2.hello.main
+  services:
+    neptune: {DescribeDBClustersPaginator}

javav2/example_code/neptune/src/main/java/com/example/neptune/HelloNeptune.java

@@ -1,107 +1,60 @@
-package com.example.neptune;
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 
-import software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider;
-import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration;
-import software.amazon.awssdk.http.apache.ApacheHttpClient;
-import software.amazon.awssdk.regions.Region;
-import software.amazon.awssdk.services.neptunedata.NeptunedataClient;
-import software.amazon.awssdk.services.neptunedata.model.ExecuteGremlinExplainQueryRequest;
-import software.amazon.awssdk.services.neptunedata.model.ExecuteGremlinExplainQueryResponse;
-import software.amazon.awssdk.services.neptunedata.model.ExecuteGremlinProfileQueryRequest;
-import software.amazon.awssdk.services.neptunedata.model.ExecuteGremlinProfileQueryResponse;
-import software.amazon.awssdk.services.neptunedata.model.NeptunedataException;
+package com.example.neptune;
 
-import java.net.URI;
-import java.time.Duration;
+import software.amazon.awssdk.core.async.SdkPublisher;
+import software.amazon.awssdk.services.neptune.NeptuneAsyncClient;
+import software.amazon.awssdk.services.neptune.model.DescribeDbClustersRequest;
+import software.amazon.awssdk.services.neptune.model.DescribeDbClustersResponse;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ExecutionException;
 
+// snippet-start:[neptune.java2.hello.main]
 /**
- * This example demonstrates how to run a Gremlin Explain and Profile query on an Amazon Neptune database
- * using the AWS SDK for Java V2.
- *
- * VPC NETWORKING REQUIREMENT:
- * ----------------------------------------------------------------------
- * Amazon Neptune is designed to be **accessed from within an Amazon VPC**.
- * It does not expose a public endpoint. This means:
- *
- * 1. Your Java application must run **within the same VPC** (e.g., via an EC2 instance, Lambda function, ECS task,
- *    or AWS Cloud9 environment), or from a peered VPC that has network access to Neptune.
- *
- * 2. You cannot run this example directly from your local machine (e.g., via IntelliJ or PyCharm on your laptop)
- *    unless you set up a VPN or AWS Direct Connect that bridges your local environment to your VPC.
- *
- * 3. You must ensure the **VPC Security Group** attached to your Neptune cluster allows **inbound access on port 8182**
- *    from the instance or environment where this Java code runs.
+ * Before running this Java V2 code example, set up your development
+ * environment, including your credentials.
  *
- * 4. The `endpointOverride()` must use the **HTTPS Neptune endpoint** including the `:8182` port.
+ * For more information, see the following documentation topic:
  *
- *  TIP:
- * You can test connectivity using `curl` or `telnet` from your instance to:
- *     curl https://<neptune-endpoint>:8182/status
- * If this fails, it’s likely a networking or security group issue.
- *
- * ----------------------------------------------------------------------
+ * https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
  */
 public class HelloNeptune {
 
     private static final String NEPTUNE_ENDPOINT = "https://[Specify-Your-Endpoint]:8182";
 
     public static void main(String[] args) {
-
-        NeptunedataClient client = NeptunedataClient.builder()
-                .credentialsProvider(DefaultCredentialsProvider.create())
-                .region(Region.US_EAST_1)
-                .endpointOverride(URI.create(NEPTUNE_ENDPOINT))
-                .httpClientBuilder(ApacheHttpClient.builder()
-                        .connectionTimeout(Duration.ofSeconds(10))
-                        .socketTimeout(Duration.ofSeconds(30)))
-                .overrideConfiguration(ClientOverrideConfiguration.builder()
-                        .apiCallAttemptTimeout(Duration.ofSeconds(30))
-                        .build())
-                .build();
-
-        try {
-            runExplainQuery(client);
-            runProfileQuery(client);
-        } catch (NeptunedataException e) {
-            System.err.println("Neptune error: " + e.awsErrorDetails().errorMessage());
-        } catch (Exception e) {
-            System.err.println("Unexpected error: " + e.getMessage());
-        } finally {
-            client.close();
-        }
+        NeptuneAsyncClient neptuneClient = NeptuneAsyncClient.create();
+        describeDbCluster(neptuneClient);
     }
 
-    private static void runExplainQuery(NeptunedataClient client) {
-        System.out.println("Running Gremlin EXPLAIN query...");
-
-        ExecuteGremlinExplainQueryRequest explainRequest = ExecuteGremlinExplainQueryRequest.builder()
-                .gremlinQuery("g.V().has('code', 'ANC')")
+    /**
+     * Describes the Amazon Neptune DB clusters using a paginator.
+     *
+     * @param neptuneClient the Amazon Neptune asynchronous client
+     */
+    public static void describeDbCluster(NeptuneAsyncClient neptuneClient) {
+        DescribeDbClustersRequest request = DescribeDbClustersRequest.builder()
+                .maxRecords(20) // Optional: limit per page
                 .build();
 
-        ExecuteGremlinExplainQueryResponse explainResponse = client.executeGremlinExplainQuery(explainRequest);
-
-        System.out.println("Explain Query Result:");
-        if (explainResponse.output() != null) {
-            System.out.println(explainResponse.output());
-        } else {
-            System.out.println("No explain output returned.");
-        }
-    }
-
-    private static void runProfileQuery(NeptunedataClient client) {
-        System.out.println("Running Gremlin PROFILE query...");
+        SdkPublisher<DescribeDbClustersResponse> paginator= neptuneClient.describeDBClustersPaginator(request);
+        CompletableFuture<Void> future = paginator
+                .subscribe(response -> {
+                    for (var cluster : response.dbClusters()) {
+                        System.out.println("Cluster Identifier: " + cluster.dbClusterIdentifier());
+                        System.out.println("Status: " + cluster.status());
+                    }
+                });
 
-        ExecuteGremlinProfileQueryRequest profileRequest = ExecuteGremlinProfileQueryRequest.builder()
-                .gremlinQuery("g.V().has('code', 'ANC')")
-                .build();
-
-        ExecuteGremlinProfileQueryResponse profileResponse = client.executeGremlinProfileQuery(profileRequest);
-
-        System.out.println("Profile Query Result:");
-        if (profileResponse.output() != null) {
-            System.out.println(profileResponse.output());
-        } else {
-            System.out.println("No profile output returned.");
+        // Wait for completion and handle errors
+        try {
+            future.get(); // Waits for all pages to be processed
+        } catch (InterruptedException | ExecutionException e) {
+            System.err.println("Failed to describe DB clusters: " + e.getMessage());
+        } finally {
+            neptuneClient.close();
         }
     }
 }
+// snippet-end:[neptune.java2.hello.main]