feat(dataplex): adjust code snippets (#9608)

* feat(dataplex): adjust snippets

* feat(dataplex): fix small typos in tests

* feat(dataplex): small adjustment in tests

---------

Co-authored-by: Jacek Spalinski <[email protected]>

Author: jacspa96

dataplex/snippets/src/main/java/dataplex/CreateAspectType.java

@@ -22,7 +22,6 @@
 import com.google.cloud.dataplex.v1.LocationName;
 import java.util.List;
 
-// Sample to create Aspect Type
 public class CreateAspectType {
 
   public static void main(String[] args) throws Exception {
@@ -59,33 +58,32 @@ public static void main(String[] args) throws Exception {
     System.out.println("Successfully created aspect type: " + createdAspectType.getName());
   }
 
+  // Method to create Aspect Type located in projectId, location and with aspectTypeId and
+  // aspectFields specifying schema of the Aspect Type
   public static AspectType createAspectType(
       String projectId,
       String location,
       String aspectTypeId,
       List<AspectType.MetadataTemplate> aspectFields)
       throws Exception {
-    LocationName locationName = LocationName.of(projectId, location);
-    AspectType aspectType =
-        AspectType.newBuilder()
-            .setDescription("description of the aspect type")
-            .setMetadataTemplate(
-                AspectType.MetadataTemplate.newBuilder()
-                    // The name must follow regex ^(([a-zA-Z]{1})([\\w\\-_]{0,62}))$
-                    // That means name must only contain alphanumeric character or dashes or
-                    // underscores, start with an alphabet, and must be less than 63 characters.
-                    .setName("name_of_the_template")
-                    .setType("record")
-                    // Aspect Type fields, that themselves are Metadata Templates
-                    .addAllRecordFields(aspectFields)
-                    .build())
-            .build();
-
     // 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,
-    // or use "try-with-close" statement to do this automatically.
+    // once, and can be reused for multiple requests.
     try (CatalogServiceClient client = CatalogServiceClient.create()) {
+      LocationName locationName = LocationName.of(projectId, location);
+      AspectType aspectType =
+          AspectType.newBuilder()
+              .setDescription("description of the aspect type")
+              .setMetadataTemplate(
+                  AspectType.MetadataTemplate.newBuilder()
+                      // The name must follow regex ^(([a-zA-Z]{1})([\\w\\-_]{0,62}))$
+                      // That means name must only contain alphanumeric character or dashes or
+                      // underscores, start with an alphabet, and must be less than 63 characters.
+                      .setName("name_of_the_template")
+                      .setType("record")
+                      // Aspect Type fields, that themselves are Metadata Templates
+                      .addAllRecordFields(aspectFields)
+                      .build())
+              .build();
       return client.createAspectTypeAsync(locationName, aspectType, aspectTypeId).get();
     }
   }

dataplex/snippets/src/main/java/dataplex/CreateEntryGroup.java

@@ -21,7 +21,6 @@
 import com.google.cloud.dataplex.v1.EntryGroup;
 import com.google.cloud.dataplex.v1.LocationName;
 
-// Samples to create Entry Group
 public class CreateEntryGroup {
 
   public static void main(String[] args) throws Exception {
@@ -35,17 +34,15 @@ public static void main(String[] args) throws Exception {
     System.out.println("Successfully created entry group: " + createdEntryGroup.getName());
   }
 
+  // Method to create Entry Group located in projectId, location and with entryGroupId
   public static EntryGroup createEntryGroup(String projectId, String location, String entryGroupId)
       throws Exception {
-    LocationName locationName = LocationName.of(projectId, location);
-    EntryGroup entryGroup =
-        EntryGroup.newBuilder().setDescription("description of the entry group").build();
-
     // 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,
-    // or use "try-with-close" statement to do this automatically.
+    // once, and can be reused for multiple requests.
     try (CatalogServiceClient client = CatalogServiceClient.create()) {
+      LocationName locationName = LocationName.of(projectId, location);
+      EntryGroup entryGroup =
+          EntryGroup.newBuilder().setDescription("description of the entry group").build();
       return client.createEntryGroupAsync(locationName, entryGroup, entryGroupId).get();
     }
   }

dataplex/snippets/src/main/java/dataplex/CreateEntryType.java

@@ -21,7 +21,6 @@
 import com.google.cloud.dataplex.v1.EntryType;
 import com.google.cloud.dataplex.v1.LocationName;
 
-// Samples to create Entry Type
 public class CreateEntryType {
 
   public static void main(String[] args) throws Exception {
@@ -35,27 +34,26 @@ public static void main(String[] args) throws Exception {
     System.out.println("Successfully created entry type: " + createdEntryType.getName());
   }
 
+  // Method to create Entry Type located in projectId, location and with entryTypeId
   public static EntryType createEntryType(String projectId, String location, String entryTypeId)
       throws Exception {
-    LocationName locationName = LocationName.of(projectId, location);
-    EntryType entryType =
-        EntryType.newBuilder()
-            .setDescription("description of the entry type")
-            // Required aspects will need to be attached to every entry created for this entry type.
-            // You cannot change required aspects for entry type once it is created.
-            .addRequiredAspects(
-                EntryType.AspectInfo.newBuilder()
-                    // Example of system aspect type.
-                    // It is also possible to specify custom aspect type.
-                    .setType("projects/dataplex-types/locations/global/aspectTypes/schema")
-                    .build())
-            .build();
-
     // 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,
-    // or use "try-with-close" statement to do this automatically.
+    // once, and can be reused for multiple requests.
     try (CatalogServiceClient client = CatalogServiceClient.create()) {
+      LocationName locationName = LocationName.of(projectId, location);
+      EntryType entryType =
+          EntryType.newBuilder()
+              .setDescription("description of the entry type")
+              // Required aspects will need to be attached to every entry created for this entry
+              // type.
+              // You cannot change required aspects for entry type once it is created.
+              .addRequiredAspects(
+                  EntryType.AspectInfo.newBuilder()
+                      // Example of system aspect type.
+                      // It is also possible to specify custom aspect type.
+                      .setType("projects/dataplex-types/locations/global/aspectTypes/schema")
+                      .build())
+              .build();
       return client.createEntryTypeAsync(locationName, entryType, entryTypeId).get();
     }
   }

dataplex/snippets/src/main/java/dataplex/DeleteAspectType.java

@@ -20,7 +20,6 @@
 import com.google.cloud.dataplex.v1.AspectTypeName;
 import com.google.cloud.dataplex.v1.CatalogServiceClient;
 
-// Sample to delete Aspect Type
 public class DeleteAspectType {
 
   public static void main(String[] args) throws Exception {
@@ -34,15 +33,13 @@ public static void main(String[] args) throws Exception {
     System.out.println("Successfully deleted aspect type");
   }
 
+  // Method to delete Aspect Type located in projectId, location and with aspectTypeId
   public static void deleteAspectType(String projectId, String location, String aspectTypeId)
       throws Exception {
-    AspectTypeName aspectTypeName = AspectTypeName.of(projectId, location, aspectTypeId);
-
     // 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,
-    // or use "try-with-close" statement to do this automatically.
+    // once, and can be reused for multiple requests.
     try (CatalogServiceClient client = CatalogServiceClient.create()) {
+      AspectTypeName aspectTypeName = AspectTypeName.of(projectId, location, aspectTypeId);
       client.deleteAspectTypeAsync(aspectTypeName).get();
     }
   }

dataplex/snippets/src/main/java/dataplex/DeleteEntryGroup.java

@@ -20,7 +20,6 @@
 import com.google.cloud.dataplex.v1.CatalogServiceClient;
 import com.google.cloud.dataplex.v1.EntryGroupName;
 
-// Sample to delete Entry Group
 public class DeleteEntryGroup {
 
   public static void main(String[] args) throws Exception {
@@ -34,15 +33,13 @@ public static void main(String[] args) throws Exception {
     System.out.println("Successfully deleted entry group");
   }
 
+  // Method to delete Entry Group located in projectId, location and with entryGroupId
   public static void deleteEntryGroup(String projectId, String location, String entryGroupId)
       throws Exception {
-    EntryGroupName entryGroupName = EntryGroupName.of(projectId, location, entryGroupId);
-
     // 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,
-    // or use "try-with-close" statement to do this automatically.
+    // once, and can be reused for multiple requests.
     try (CatalogServiceClient client = CatalogServiceClient.create()) {
+      EntryGroupName entryGroupName = EntryGroupName.of(projectId, location, entryGroupId);
       client.deleteEntryGroupAsync(entryGroupName).get();
     }
   }

dataplex/snippets/src/main/java/dataplex/DeleteEntryType.java

@@ -20,7 +20,6 @@
 import com.google.cloud.dataplex.v1.CatalogServiceClient;
 import com.google.cloud.dataplex.v1.EntryTypeName;
 
-// Sample to delete Entry Type
 public class DeleteEntryType {
 
   public static void main(String[] args) throws Exception {
@@ -34,15 +33,13 @@ public static void main(String[] args) throws Exception {
     System.out.println("Successfully deleted entry type");
   }
 
+  // Method to delete Entry Type located in projectId, location and with entryTypeId
   public static void deleteEntryType(String projectId, String location, String entryTypeId)
       throws Exception {
-    EntryTypeName entryTypeName = EntryTypeName.of(projectId, location, entryTypeId);
-
     // 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,
-    // or use "try-with-close" statement to do this automatically.
+    // once, and can be reused for multiple requests.
     try (CatalogServiceClient client = CatalogServiceClient.create()) {
+      EntryTypeName entryTypeName = EntryTypeName.of(projectId, location, entryTypeId);
       client.deleteEntryTypeAsync(entryTypeName).get();
     }
   }

dataplex/snippets/src/main/java/dataplex/GetAspectType.java

@@ -22,7 +22,6 @@
 import com.google.cloud.dataplex.v1.CatalogServiceClient;
 import java.io.IOException;
 
-// Sample to get Aspect Type
 public class GetAspectType {
 
   public static void main(String[] args) throws IOException {
@@ -36,15 +35,13 @@ public static void main(String[] args) throws IOException {
     System.out.println("Aspect type retrieved successfully: " + aspectType.getName());
   }
 
+  // Method to retrieve Aspect Type located in projectId, location and with aspectTypeId
   public static AspectType getAspectType(String projectId, String location, String aspectTypeId)
       throws IOException {
-    AspectTypeName aspectTypeName = AspectTypeName.of(projectId, location, aspectTypeId);
-
     // 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,
-    // or use "try-with-close" statement to do this automatically.
+    // once, and can be reused for multiple requests.
     try (CatalogServiceClient client = CatalogServiceClient.create()) {
+      AspectTypeName aspectTypeName = AspectTypeName.of(projectId, location, aspectTypeId);
       return client.getAspectType(aspectTypeName);
     }
   }

dataplex/snippets/src/main/java/dataplex/GetEntryGroup.java

@@ -22,7 +22,6 @@
 import com.google.cloud.dataplex.v1.EntryGroupName;
 import java.io.IOException;
 
-// Sample to get Entry Group
 public class GetEntryGroup {
 
   public static void main(String[] args) throws IOException {
@@ -36,15 +35,13 @@ public static void main(String[] args) throws IOException {
     System.out.println("Entry group retrieved successfully: " + entryGroup.getName());
   }
 
+  // Method to retrieve Entry Group located in projectId, location and with entryGroupId
   public static EntryGroup getEntryGroup(String projectId, String location, String entryGroupId)
       throws IOException {
-    EntryGroupName entryGroupName = EntryGroupName.of(projectId, location, entryGroupId);
-
     // 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,
-    // or use "try-with-close" statement to do this automatically.
+    // once, and can be reused for multiple requests.
     try (CatalogServiceClient client = CatalogServiceClient.create()) {
+      EntryGroupName entryGroupName = EntryGroupName.of(projectId, location, entryGroupId);
       return client.getEntryGroup(entryGroupName);
     }
   }

dataplex/snippets/src/main/java/dataplex/GetEntryType.java

@@ -22,7 +22,6 @@
 import com.google.cloud.dataplex.v1.EntryTypeName;
 import java.io.IOException;
 
-// Sample to get Entry Type
 public class GetEntryType {
 
   public static void main(String[] args) throws IOException {
@@ -36,15 +35,13 @@ public static void main(String[] args) throws IOException {
     System.out.println("Entry type retrieved successfully: " + entryType.getName());
   }
 
+  // Method to retrieve Entry Type located in projectId, location and with entryTypeId
   public static EntryType getEntryType(String projectId, String location, String entryTypeId)
       throws IOException {
-    EntryTypeName entryTypeName = EntryTypeName.of(projectId, location, entryTypeId);
-
     // 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,
-    // or use "try-with-close" statement to do this automatically.
+    // once, and can be reused for multiple requests.
     try (CatalogServiceClient client = CatalogServiceClient.create()) {
+      EntryTypeName entryTypeName = EntryTypeName.of(projectId, location, entryTypeId);
       return client.getEntryType(entryTypeName);
     }
   }

dataplex/snippets/src/main/java/dataplex/ListAspectTypes.java

@@ -24,7 +24,6 @@
 import java.io.IOException;
 import java.util.List;
 
-// Sample to list Aspect Types
 public class ListAspectTypes {
 
   public static void main(String[] args) throws IOException {
@@ -38,15 +37,13 @@ public static void main(String[] args) throws IOException {
         aspectType -> System.out.println("Aspect type name: " + aspectType.getName()));
   }
 
+  // Method to list Aspect Types located in projectId and location
   public static List<AspectType> listAspectTypes(String projectId, String location)
       throws IOException {
-    LocationName locationName = LocationName.of(projectId, location);
-
     // 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,
-    // or use "try-with-close" statement to do this automatically.
+    // once, and can be reused for multiple requests.
     try (CatalogServiceClient client = CatalogServiceClient.create()) {
+      LocationName locationName = LocationName.of(projectId, location);
       CatalogServiceClient.ListAspectTypesPagedResponse listAspectTypesResponse =
           client.listAspectTypes(locationName);
       // Paging is implicitly handled by .iterateAll(), all results will be returned