docs(samples): Refactoring product package (Import) (new)

samples/interactive-tutorials/src/main/java/product/ImportProductsBigQueryTable.java

@@ -33,36 +33,30 @@
 import com.google.longrunning.Operation;
 import com.google.longrunning.OperationsClient;
 import java.io.IOException;
+import java.util.concurrent.TimeUnit;
 
 public class ImportProductsBigQueryTable {
 
   public static void main(String[] args) throws IOException, InterruptedException {
-    // TODO(developer): Replace these variables before running the sample.
     String projectId = ServiceOptions.getDefaultProjectId();
     String branchName =
         String.format(
             "projects/%s/locations/global/catalogs/default_catalog/branches/0", projectId);
     String datasetId = "products";
     String tableId = "products";
     // TO CHECK ERROR HANDLING USE THE TABLE WITH INVALID PRODUCTS:
-    // TABLE_ID = "products_some_invalid"
-    String dataSchema = "product";
-    // TRY THE FULL RECONCILIATION MODE HERE:
-    ReconciliationMode reconciliationMode = ReconciliationMode.INCREMENTAL;
+    // tableId = "products_some_invalid"
 
-    ImportProductsRequest importBigQueryRequest =
-        getImportProductsBigQueryRequest(
-            reconciliationMode, projectId, datasetId, tableId, dataSchema, branchName);
-    waitForOperationCompletion(importBigQueryRequest);
+    importProductsFromBigQuery(projectId, branchName, datasetId, tableId);
   }
 
-  public static ImportProductsRequest getImportProductsBigQueryRequest(
-      ReconciliationMode reconciliationMode,
-      String projectId,
-      String datasetId,
-      String tableId,
-      String dataSchema,
-      String branchName) {
+  public static void importProductsFromBigQuery(
+      String projectId, String branchName, String datasetId, String tableId)
+      throws IOException, InterruptedException {
+    // TRY THE FULL RECONCILIATION MODE HERE:
+    ReconciliationMode reconciliationMode = ReconciliationMode.INCREMENTAL;
+    String dataSchema = "product";
+
     BigQuerySource bigQuerySource =
         BigQuerySource.newBuilder()
             .setProjectId(projectId)
@@ -82,30 +76,29 @@ public static ImportProductsRequest getImportProductsBigQueryRequest(
             .build();
     System.out.printf("Import products from big query table request: %s%n", importRequest);
 
-    return importRequest;
-  }
-
-  public static void waitForOperationCompletion(ImportProductsRequest importRequest)
-      throws IOException, InterruptedException {
+    // Initialize client that will be used to send requests. This client only
+    // needs to be created once, and can be reused for multiple requests. After
+    // completing all of your requests, call the "close" method on the client to
+    // safely clean up any remaining background resources.
     try (ProductServiceClient serviceClient = ProductServiceClient.create()) {
       String operationName = serviceClient.importProductsCallable().call(importRequest).getName();
-      System.out.printf("OperationName = %s\n", operationName);
+      System.out.printf("OperationName = %s%n", operationName);
 
       OperationsClient operationsClient = serviceClient.getOperationsClient();
       Operation operation = operationsClient.getOperation(operationName);
 
       while (!operation.getDone()) {
         // Keep polling the operation periodically until the import task is done.
-        Thread.sleep(30_000);
+        TimeUnit.SECONDS.sleep(30);
         operation = operationsClient.getOperation(operationName);
       }
 
       if (operation.hasMetadata()) {
         ImportMetadata metadata = operation.getMetadata().unpack(ImportMetadata.class);
         System.out.printf(
-            "Number of successfully imported products: %s\n", metadata.getSuccessCount());
+            "Number of successfully imported products: %s%n", metadata.getSuccessCount());
         System.out.printf(
-            "Number of failures during the importing: %s\n", metadata.getFailureCount());
+            "Number of failures during the importing: %s%n", metadata.getFailureCount());
       }
 
       if (operation.hasResponse()) {

samples/interactive-tutorials/src/main/java/product/ImportProductsGcs.java

@@ -22,6 +22,8 @@
 
 package product;
 
+import com.google.api.gax.rpc.InvalidArgumentException;
+import com.google.api.gax.rpc.PermissionDeniedException;
 import com.google.cloud.ServiceOptions;
 import com.google.cloud.retail.v2.GcsSource;
 import com.google.cloud.retail.v2.ImportErrorsConfig;
@@ -35,32 +37,33 @@
 import com.google.longrunning.OperationsClient;
 import java.io.IOException;
 import java.util.Collections;
+import java.util.concurrent.TimeUnit;
 
 public class ImportProductsGcs {
 
   public static void main(String[] args) throws IOException, InterruptedException {
-    // TODO(developer): Replace these variables before running the sample.
     String projectId = ServiceOptions.getDefaultProjectId();
     String branchName =
         String.format(
             "projects/%s/locations/global/catalogs/default_catalog/branches/0", projectId);
-    String gcsBucket = String.format("gs://%s", System.getenv("BUCKET_NAME"));
-    String gcsErrorBucket = String.format("%s/errors", gcsBucket);
+    String bucketName = System.getenv("BUCKET_NAME");
+    String gcsBucket = String.format("gs://%s", bucketName);
     String gscProductsObject = "products.json";
     // TO CHECK ERROR HANDLING USE THE JSON WITH INVALID PRODUCT
-    // GCS_PRODUCTS_OBJECT = "products_some_invalid.json"
+    // gscProductsObject = "products_some_invalid.json"
 
-    ImportProductsRequest importGcsRequest =
-        getImportProductsGcsRequest(gscProductsObject, gcsBucket, gcsErrorBucket, branchName);
-    waitForOperationCompletion(importGcsRequest);
+    importProductsFromGcs(branchName, bucketName, gcsBucket, gscProductsObject);
   }
 
-  public static ImportProductsRequest getImportProductsGcsRequest(
-      String gcsObjectName, String gcsBucket, String gcsErrorBucket, String branchName) {
+  public static void importProductsFromGcs(
+      String branchName, String bucketName, String gcsBucket, String gscProductsObject)
+      throws IOException, InterruptedException {
+    String gcsErrorBucket = String.format("%s/errors", gcsBucket);
+
     GcsSource gcsSource =
         GcsSource.newBuilder()
             .addAllInputUris(
-                Collections.singleton(String.format("%s/%s", gcsBucket, gcsObjectName)))
+                Collections.singleton(String.format("%s/%s", gcsBucket, gscProductsObject)))
             .build();
 
     ProductInputConfig inputConfig =
@@ -79,39 +82,53 @@ public static ImportProductsRequest getImportProductsGcsRequest(
             .setErrorsConfig(errorsConfig)
             .build();
 
-    System.out.println("Import products from google cloud source request: " + importRequest);
+    System.out.printf("Import products from google cloud source request: %s%n", importRequest);
 
-    return importRequest;
-  }
-
-  public static void waitForOperationCompletion(ImportProductsRequest importRequest)
-      throws IOException, InterruptedException {
+    // Initialize client that will be used to send requests. This client only
+    // needs to be created once, and can be reused for multiple requests. After
+    // completing all of your requests, call the "close" method on the client to
+    // safely clean up any remaining background resources.
     try (ProductServiceClient serviceClient = ProductServiceClient.create()) {
       String operationName = serviceClient.importProductsCallable().call(importRequest).getName();
-      System.out.printf("OperationName = %s\n", operationName);
+
+      System.out.println("The operation was started.");
+      System.out.printf("OperationName = %s%n", operationName);
 
       OperationsClient operationsClient = serviceClient.getOperationsClient();
       Operation operation = operationsClient.getOperation(operationName);
 
-      while (!operation.getDone()) {
-        // Keep polling the operation periodically until the import task is done.
-        Thread.sleep(30_000);
+      long assuredBreak = System.currentTimeMillis() + 60000; // 60 seconds delay
+
+      while (!operation.getDone() || System.currentTimeMillis() < assuredBreak) {
+        System.out.println("Please wait till operation is done.");
+        TimeUnit.SECONDS.sleep(30);
         operation = operationsClient.getOperation(operationName);
       }
 
       if (operation.hasMetadata()) {
         ImportMetadata metadata = operation.getMetadata().unpack(ImportMetadata.class);
         System.out.printf(
-            "Number of successfully imported products: %s\n", metadata.getSuccessCount());
+            "Number of successfully imported products: %s%n", metadata.getSuccessCount());
         System.out.printf(
-            "Number of failures during the importing: %s\n", metadata.getFailureCount());
+            "Number of failures during the importing: %s%n", metadata.getFailureCount());
+      } else {
+        System.out.println("Metadata is empty.");
       }
 
       if (operation.hasResponse()) {
         ImportProductsResponse response =
             operation.getResponse().unpack(ImportProductsResponse.class);
         System.out.printf("Operation result: %s%n", response);
+      } else {
+        System.out.println("Operation result is empty.");
       }
+    } catch (InvalidArgumentException e) {
+      System.out.printf(
+          "%s%n'%s' file does not exist in the bucket. Please "
+              + "make sure you have followed the setting up instructions.",
+          e.getMessage(), gscProductsObject);
+    } catch (PermissionDeniedException e) {
+      System.out.println(e.getMessage());
     }
   }
 }