Clean up comments.

Author: kurtisvg

dlp/src/main/java/dlp/snippets/InspectImageFile.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2018 Google LLC
+ * Copyright 2019 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -38,14 +38,15 @@ public class InspectImageFile {
   public static void inspectImageFile(String projectId, String filePath) {
     // String projectId = "my-project-id";
     // String filePath = "path/to/image.png";
-    // String fileType = "IMAGE"
 
-    // Initialize client with try-with-resources for automatic cleanup of background resources
+    // 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 (DlpServiceClient dlp = DlpServiceClient.create()) {
-      // Set project for request
+      // Specify the project used for request.
       ProjectName project = ProjectName.of(projectId);
 
-      // Set content for request
+      // Specify the type and content to be inspected.
       ByteString fileBytes = ByteString.readFrom(new FileInputStream(filePath));
       ByteContentItem byteItem = ByteContentItem.newBuilder()
           .setType(BytesType.IMAGE)
@@ -55,38 +56,38 @@ public static void inspectImageFile(String projectId, String filePath) {
           .setByteItem(byteItem)
           .build();
 
-      // Set required InfoTypes for inspection config
+      // Specify the type of info the inspection will look for.
       List<InfoType> infoTypes = new ArrayList<>();
       // See https://cloud.google.com/dlp/docs/infotypes-reference for complete list of info types
       for (String typeName : new String[] {"PHONE_NUMBER", "EMAIL_ADDRESS", "CREDIT_CARD_NUMBER"}) {
         infoTypes.add(InfoType.newBuilder().setName(typeName).build());
       }
 
-      // Set the inspect configuration for request
+      // Construct the configuration for the Inspect request.
       InspectConfig config = InspectConfig.newBuilder()
           .addAllInfoTypes(infoTypes)
           .setIncludeQuote(true)
           .build();
 
-      // Construct the request to be sent by the client
+      // Construct the Inspect request to be sent by the client.
       InspectContentRequest request = InspectContentRequest.newBuilder()
           .setParent(project.toString())
           .setItem(item)
           .setInspectConfig(config)
           .build();
 
-      // Use the client to send the API request
+      // Use the client to send the API request.
       InspectContentResponse response = dlp.inspectContent(request);
 
-      // Parse the response and process results
+      // Parse the response and process results.
       System.out.println("Findings: " + response.getResult().getFindingsCount());
       for (Finding f : response.getResult().getFindingsList()) {
         System.out.println("\tQuote: " + f.getQuote());
         System.out.println("\tInfo type: " + f.getInfoType().getName());
         System.out.println("\tLikelihood: " + f.getLikelihood());
       }
     } catch (Exception e) {
-      System.out.println("Error during inspectFile: \n" + e.toString());
+      System.out.println("Error during inspectImageFile: \n" + e.toString());
     }
   }
 }

dlp/src/main/java/dlp/snippets/InspectString.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2018 Google LLC
+ * Copyright 2019 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -38,39 +38,41 @@ public static void inspectString(String projectId, String textToInspect) {
     // String projectId = "my-project-id";
     // String textToInspect = "My name is Gary and my email is [email protected]";
 
-    // Initialize client with try-with-resources for automatic cleanup of background resources
+    // 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 (DlpServiceClient dlp = DlpServiceClient.create()) {
-      // Set project for request
+      // Specify the project used for request.
       ProjectName project = ProjectName.of(projectId);
 
-      // Set content for request
+      // Specify the type and content to be inspected.
       ByteContentItem byteItem = ByteContentItem.newBuilder()
           .setType(BytesType.TEXT_UTF8)
           .setData(ByteString.copyFromUtf8(textToInspect))
           .build();
       ContentItem item = ContentItem.newBuilder().setByteItem(byteItem).build();
 
-      // Set required InfoTypes for inspection config
+      // Specify the type of info the inspection will look for.
       List<InfoType> infoTypes = new ArrayList<>();
       // See https://cloud.google.com/dlp/docs/infotypes-reference for complete list of info types
       for (String typeName : new String[] {"PHONE_NUMBER", "EMAIL_ADDRESS", "CREDIT_CARD_NUMBER"}) {
         infoTypes.add(InfoType.newBuilder().setName(typeName).build());
       }
 
-      // Set the inspect configuration for request
+      // Construct the configuration for the Inspect request.
       InspectConfig config = InspectConfig.newBuilder()
           .addAllInfoTypes(infoTypes)
           .setIncludeQuote(true)
           .build();
 
-      // Construct request
+      // Construct the Inspect request to be sent by the client.
       InspectContentRequest request = InspectContentRequest.newBuilder()
           .setParent(project.toString())
           .setItem(item)
           .setInspectConfig(config)
           .build();
 
-      // Use the client to send the API request
+      // Use the client to send the API request.
       InspectContentResponse response = dlp.inspectContent(request);
 
       // Parse the response and process results

dlp/src/main/java/dlp/snippets/InspectTextFile.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2018 Google LLC
+ * Copyright 2019 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -38,14 +38,15 @@ public class InspectTextFile {
   public static void inspectTextFile(String projectId, String filePath) {
     // String projectId = "my-project-id";
     // String filePath = "path/to/image.png";
-    // String fileType = "IMAGE"
 
-    // Initialize client with try-with-resources for automatic cleanup of background resources
+    // 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 (DlpServiceClient dlp = DlpServiceClient.create()) {
-      // Set project for request
+      // Specify the project used for request.
       ProjectName project = ProjectName.of(projectId);
 
-      // Set content for request
+      // Specify the type and content to be inspected.
       ByteString fileBytes = ByteString.readFrom(new FileInputStream(filePath));
       ByteContentItem byteItem = ByteContentItem.newBuilder()
           .setType(BytesType.TEXT_UTF8)
@@ -55,27 +56,27 @@ public static void inspectTextFile(String projectId, String filePath) {
           .setByteItem(byteItem)
           .build();
 
-      // Set required InfoTypes for inspection config
+      // Specify the type of info the inspection will look for.
       List<InfoType> infoTypes = new ArrayList<>();
       // See https://cloud.google.com/dlp/docs/infotypes-reference for complete list of info types
       for (String typeName : new String[] {"PHONE_NUMBER", "EMAIL_ADDRESS", "CREDIT_CARD_NUMBER"}) {
         infoTypes.add(InfoType.newBuilder().setName(typeName).build());
       }
 
-      // Set the inspect configuration for request
+      // Construct the configuration for the Inspect request.
       InspectConfig config = InspectConfig.newBuilder()
           .addAllInfoTypes(infoTypes)
           .setIncludeQuote(true)
           .build();
 
-      // Construct the request to be sent by the client
+      // Construct the Inspect request to be sent by the client.
       InspectContentRequest request = InspectContentRequest.newBuilder()
           .setParent(project.toString())
           .setItem(item)
           .setInspectConfig(config)
           .build();
 
-      // Use the client to send the API request
+      // Use the client to send the API request.
       InspectContentResponse response = dlp.inspectContent(request);
 
       // Parse the response and process results

dlp/src/test/java/dlp/snippets/RedactTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2018 Google LLC
+ * Copyright 2019 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -62,30 +62,11 @@ public void tearDown() {
   }
 
   @Test
-  public void testInspectString() {
-    InspectString.inspectString(PROJECT_ID,  "I'm Gary and my email is [email protected]");
+  public void testRedactImage() {
+    RedactImageFile.redactImageFile(PROJECT_ID,  "src/test/resources/test.png");
 
     String output = bout.toString();
     assertThat(output, CoreMatchers.containsString("Info type: EMAIL_ADDRESS"));
   }
 
-  @Test
-  public void textInspectTestFile() {
-    InspectTextFile.inspectTextFile(PROJECT_ID,  "src/test/resources/test.txt");
-
-    String output = bout.toString();
-    assertThat(output, CoreMatchers.containsString("Info type: PHONE_NUMBER"));
-    assertThat(output, CoreMatchers.containsString("Info type: EMAIL_ADDRESS"));
-  }
-
-
-  @Test
-  public void testInspectImageFile() {
-    InspectImageFile.inspectImageFile(PROJECT_ID,  "src/test/resources/test.png");
-
-    String output = bout.toString();
-    assertThat(output, CoreMatchers.containsString("Info type: PHONE_NUMBER"));
-    assertThat(output, CoreMatchers.containsString("Info type: EMAIL_ADDRESS"));
-  }
-
 }