Purge Products

vision/product-search/cloud-client/pom.xml

@@ -40,12 +40,12 @@
     <dependency>
       <groupId>com.google.cloud</groupId>
       <artifactId>google-cloud-vision</artifactId>
-      <version>1.52.0</version>
+      <version>1.88.0</version>
     </dependency>
     <dependency>
       <groupId>com.google.cloud</groupId>
       <artifactId>google-cloud-storage</artifactId>
-      <version>1.52.0</version>
+      <version>1.88.0</version>
     </dependency>
     <dependency>
       <groupId>net.sourceforge.argparse4j</groupId>

vision/product-search/cloud-client/src/main/java/com/example/vision/ProductInProductSetManagement.java

@@ -16,12 +16,21 @@
 
 package com.example.vision;
 
+import com.google.api.gax.longrunning.OperationFuture;
+
+import com.google.cloud.vision.v1.BatchOperationMetadata;
+import com.google.cloud.vision.v1.LocationName;
 import com.google.cloud.vision.v1.Product;
 import com.google.cloud.vision.v1.ProductName;
 import com.google.cloud.vision.v1.ProductSearchClient;
+import com.google.cloud.vision.v1.ProductSetPurgeConfig;
+import com.google.cloud.vision.v1.PurgeProductsRequest;
+
+import com.google.protobuf.Empty;
 
 import java.io.IOException;
 import java.io.PrintStream;
+import java.util.concurrent.TimeUnit;
 
 import net.sourceforge.argparse4j.ArgumentParsers;
 import net.sourceforge.argparse4j.inf.ArgumentParser;
@@ -135,6 +144,50 @@ public static void removeProductFromProductSet(
   }
   // [END vision_product_search_remove_product_from_product_set]
 
+  // [START vision_product_search_purge_products_in_product_set]
+  /**
+   * Delete all products in a product set.
+   *
+   * @param projectId - Id of the project.
+   * @param location - Region name.
+   * @param productSetId - Id of the product set.
+   * @param force - Perform the purge only when force is set to True.
+   * @throws Exception - any error.
+   */
+  public static void purgeProductsInProductSet(
+          String projectId, String location, String productSetId, boolean force)
+          throws Exception {
+    try (ProductSearchClient client = ProductSearchClient.create()) {
+
+      String parent = LocationName.format(projectId, location);
+      ProductSetPurgeConfig productSetPurgeConfig = ProductSetPurgeConfig
+              .newBuilder()
+              .setProductSetId(productSetId)
+              .build();
+
+      PurgeProductsRequest req = PurgeProductsRequest
+              .newBuilder()
+              .setParent(parent)
+              .setProductSetPurgeConfig(productSetPurgeConfig)
+              // The operation is irreversible and removes multiple products.
+              // The user is required to pass in force=True to actually perform the
+              // purge.
+              // If force is not set to True, the service raises an exception.
+              .setForce(force)
+              .build();
+
+      //TODO: once its supported in all regions, will change it to 60 sec.
+      // testing method with region asia-east1 seems bit slower than normal.
+
+      OperationFuture<Empty, BatchOperationMetadata> response = client.purgeProductsAsync(req);
+      response.getPollingFuture().get(90, TimeUnit.MINUTES);
+
+      System.out.println("Products removed from product set.");
+    }
+
+  }
+  // [END vision_product_search_purge_products_in_product_set]
+
   public static void main(String[] args) throws Exception {
     ProductInProductSetManagement productInProductSetManagement =
         new ProductInProductSetManagement();
@@ -157,6 +210,11 @@ public static void argsHelper(String[] args, PrintStream out) throws Exception {
     removeProductFromProductSetParser.addArgument("productId");
     removeProductFromProductSetParser.addArgument("productSetId");
 
+    Subparser purgeProductsInProductSetParser =
+            subparsers.addParser("purge_products_in_product_set");
+    purgeProductsInProductSetParser.addArgument("productSetId");
+    purgeProductsInProductSetParser.addArgument("force");
+
     String projectId = System.getenv("PROJECT_ID");
     String computeRegion = System.getenv("REGION_NAME");
 
@@ -172,7 +230,13 @@ public static void argsHelper(String[] args, PrintStream out) throws Exception {
       }
       if (ns.get("command").equals("remove_product_from_product_set")) {
         removeProductFromProductSet(
-            projectId, computeRegion, ns.getString("productId"), ns.getString("productSetId"));
+                projectId, computeRegion, ns.getString("productId"), ns.getString("productSetId"));
+      }
+      System.out.println(ns.getAttrs());
+      if (ns.get("command").equals("purge_products_in_product_set")) {
+        purgeProductsInProductSet(
+                projectId, computeRegion, ns.getString("productSetId"),
+                Boolean.parseBoolean(ns.getString("force")));
       }
 
     } catch (ArgumentParserException e) {

vision/product-search/cloud-client/src/main/java/com/example/vision/ProductManagement.java

@@ -16,13 +16,17 @@
 
 package com.example.vision;
 
+import com.google.api.gax.longrunning.OperationFuture;
+import com.google.cloud.vision.v1.LocationName;
 import com.google.cloud.vision.v1.Product;
 import com.google.cloud.vision.v1.Product.KeyValue;
 import com.google.cloud.vision.v1.ProductSearchClient;
+import com.google.cloud.vision.v1.PurgeProductsRequest;
 import com.google.protobuf.FieldMask;
 
 import java.io.IOException;
 import java.io.PrintStream;
+import java.util.concurrent.TimeUnit;
 
 import net.sourceforge.argparse4j.ArgumentParsers;
 import net.sourceforge.argparse4j.inf.ArgumentParser;
@@ -213,6 +217,40 @@ public static void deleteProduct(String projectId, String computeRegion, String
   }
   // [END vision_product_search_delete_product]
 
+  // [START vision_product_search_purge_orphan_products]
+  /**
+   * Delete the product and all its reference images.
+   *
+   * @param projectId - Id of the project.
+   * @param computeRegion - A compute region name.
+   * @param force - Perform the purge only when force is set to True.
+   * @throws Exception - on I/O and API errors.
+   */
+  public static void purgeOrphanProducts(String projectId, String computeRegion, boolean force)
+          throws Exception {
+    try (ProductSearchClient client = ProductSearchClient.create()) {
+
+      String parent = LocationName.format(projectId, computeRegion);
+
+      // The purge operation is async.
+      PurgeProductsRequest req = PurgeProductsRequest
+              .newBuilder()
+              .setDeleteOrphanProducts(true)
+              .setForce(force)
+              .setParent(parent)
+              .build();
+
+      OperationFuture response = client.purgeProductsAsync(req);
+
+      //TODO: once its supported in all regions, will change it to 60 sec.
+      // testing method with region asia-east1 seems bit slower than normal.
+      response.getPollingFuture().get(90, TimeUnit.SECONDS);
+
+      System.out.println("Orphan products deleted.");
+    }
+  }
+  // [END vision_product_search_purge_orphan_products]
+
   public static void main(String[] args) throws Exception {
     ProductManagement productManagement = new ProductManagement();
     productManagement.argsHelper(args, System.out);
@@ -241,6 +279,9 @@ public void argsHelper(String[] args, PrintStream out) throws Exception {
     Subparser deleteProductParser = subparsers.addParser("delete_product");
     deleteProductParser.addArgument("productId");
 
+    Subparser purgeOrphanProductsParser = subparsers.addParser("purge_orphan_products");
+    purgeOrphanProductsParser.addArgument("force");
+
     String projectId = System.getenv("PROJECT_ID");
     String computeRegion = System.getenv("REGION_NAME");
 
@@ -268,7 +309,9 @@ public void argsHelper(String[] args, PrintStream out) throws Exception {
       if (ns.get("command").equals("delete_product")) {
         deleteProduct(projectId, computeRegion, ns.getString("productId"));
       }
-
+      if (ns.get("command").equals("purge_orphan_products")) {
+        purgeOrphanProducts(projectId, computeRegion, Boolean.parseBoolean(ns.getString("force")));
+      }
     } catch (ArgumentParserException e) {
       parser.handleError(e);
     }

vision/product-search/cloud-client/src/main/java/com/example/vision/ReferenceImageManagement.java

@@ -16,6 +16,8 @@
 
 package com.example.vision;
 
+import com.google.cloud.vision.v1.Image;
+import com.google.cloud.vision.v1.ImageName;
 import com.google.cloud.vision.v1.ProductSearchClient;
 import com.google.cloud.vision.v1.ReferenceImage;
 
@@ -123,7 +125,7 @@ public static void getReferenceImage(
 
       // Get the full path of the reference image.
       String formattedName =
-          ProductSearchClient.formatImageName(
+              ImageName.format(
               projectId, computeRegion, productId, referenceImageId);
       // Get complete detail of the reference image.
       ReferenceImage image = client.getReferenceImage(formattedName);
@@ -158,7 +160,7 @@ public static void deleteReferenceImage(
 
       // Get the full path of the reference image.
       String formattedName =
-          ProductSearchClient.formatImageName(
+              ImageName.format(
               projectId, computeRegion, productId, referenceImageId);
       // Delete the reference image.
       client.deleteReferenceImage(formattedName);

vision/product-search/cloud-client/src/test/java/com/example/vision/ProductInProductSetManagementIT.java

@@ -106,4 +106,28 @@ public void testRemoveProductFromProductSet() throws Exception {
     got = bout.toString();
     assertThat(got).doesNotContain(PRODUCT_ID);
   }
+
+  @Test
+  public void testPurgeProductsInProductSet() throws Exception {
+    // Act
+    ProductInProductSetManagement.addProductToProductSet(
+            PROJECT_ID, COMPUTE_REGION, PRODUCT_ID, PRODUCT_SET_ID);
+    ProductManagement.listProducts(
+            PROJECT_ID, COMPUTE_REGION);
+
+    // Assert
+    String got = bout.toString();
+    assertThat(got).contains(PRODUCT_ID);
+
+    bout.reset();
+    ProductInProductSetManagement.purgeProductsInProductSet(
+            PROJECT_ID, COMPUTE_REGION, PRODUCT_SET_ID, true);
+
+    ProductManagement.listProducts(
+            PROJECT_ID, COMPUTE_REGION);
+
+    // Assert
+    got = bout.toString();
+    assertThat(got).doesNotContain(PRODUCT_ID);
+  }
 }

vision/product-search/cloud-client/src/test/java/com/example/vision/ProductManagementIT.java

@@ -120,4 +120,26 @@ public void testUpdateProductLabels() throws Exception {
     assertThat(got).contains(KEY);
     assertThat(got).contains(VALUE);
   }
+
+  @Test
+  public void testPurgeOrphanProducts() throws Exception {
+    // Act
+    ProductManagement.createProduct(
+            PROJECT_ID, COMPUTE_REGION, PRODUCT_ID, PRODUCT_DISPLAY_NAME, PRODUCT_CATEGORY);
+    ProductManagement.listProducts(PROJECT_ID, COMPUTE_REGION);
+
+    // Assert
+    String got = bout.toString();
+    assertThat(got).contains(PRODUCT_ID);
+
+    bout.reset();
+
+    // Act
+    ProductManagement.purgeOrphanProducts(PROJECT_ID, COMPUTE_REGION, true);
+
+    // Assert
+    got = bout.toString();
+    ProductManagement.listProducts(PROJECT_ID, COMPUTE_REGION);
+    assertThat(got).doesNotContain(PRODUCT_ID);
+  }
 }