feat(dataplex): adjust code samples for Aspect Type (#9575)

* feat(dataplex): explicitly pass arguments to the functions

* feat(dataplex): adjust integration tests to changed functions' signatures

* feat(dataplex): remove snake case from test methods' names

---------

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

Author: jacspa96

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

@@ -32,7 +32,6 @@ public static void main(String[] args) throws Exception {
     String location = "MY_LOCATION";
     String aspectTypeId = "MY_ASPECT_TYPE_ID";
 
-    LocationName locationName = LocationName.of(projectId, location);
     AspectType.MetadataTemplate aspectField =
         AspectType.MetadataTemplate.newBuilder()
             // The name must follow regex ^(([a-zA-Z]{1})([\\w\\-_]{0,62}))$
@@ -55,15 +54,18 @@ public static void main(String[] args) throws Exception {
                     .build())
             .build();
     List<AspectType.MetadataTemplate> aspectFields = List.of(aspectField);
-    AspectType createdAspectType = createAspectType(locationName, aspectTypeId, aspectFields);
+    AspectType createdAspectType =
+        createAspectType(projectId, location, aspectTypeId, aspectFields);
     System.out.println("Successfully created aspect type: " + createdAspectType.getName());
   }
 
   public static AspectType createAspectType(
-      LocationName locationName,
+      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")

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

@@ -30,12 +30,14 @@ public static void main(String[] args) throws Exception {
     String location = "MY_LOCATION";
     String aspectTypeId = "MY_ASPECT_TYPE_ID";
 
-    AspectTypeName aspectTypeName = AspectTypeName.of(projectId, location, aspectTypeId);
-    deleteAspectType(aspectTypeName);
+    deleteAspectType(projectId, location, aspectTypeId);
     System.out.println("Successfully deleted aspect type");
   }
 
-  public static void deleteAspectType(AspectTypeName aspectTypeName) throws Exception {
+  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,

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

@@ -32,12 +32,14 @@ public static void main(String[] args) throws IOException {
     String location = "MY_LOCATION";
     String aspectTypeId = "MY_ASPECT_TYPE_ID";
 
-    AspectTypeName aspectTypeName = AspectTypeName.of(projectId, location, aspectTypeId);
-    AspectType aspectType = getAspectType(aspectTypeName);
+    AspectType aspectType = getAspectType(projectId, location, aspectTypeId);
     System.out.println("Aspect type retrieved successfully: " + aspectType.getName());
   }
 
-  public static AspectType getAspectType(AspectTypeName aspectTypeName) throws IOException {
+  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,

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

@@ -33,20 +33,23 @@ public static void main(String[] args) throws IOException {
     // Available locations: https://cloud.google.com/dataplex/docs/locations
     String location = "MY_LOCATION";
 
-    LocationName locationName = LocationName.of(projectId, location);
-    List<AspectType> aspectTypes = listAspectTypes(locationName);
+    List<AspectType> aspectTypes = listAspectTypes(projectId, location);
     aspectTypes.forEach(
         aspectType -> System.out.println("Aspect type name: " + aspectType.getName()));
   }
 
-  public static List<AspectType> listAspectTypes(LocationName locationName) throws IOException {
+  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.
     try (CatalogServiceClient client = CatalogServiceClient.create()) {
       CatalogServiceClient.ListAspectTypesPagedResponse listAspectTypesResponse =
           client.listAspectTypes(locationName);
+      // Paging is implicitly handled by .iterateAll(), all results will be returned
       return ImmutableList.copyOf(listAspectTypesResponse.iterateAll());
     }
   }

dataplex/snippets/src/main/java/dataplex/UpdateAspectType.java

@@ -33,7 +33,6 @@ public static void main(String[] args) throws Exception {
     String location = "MY_LOCATION";
     String aspectTypeId = "MY_ASPECT_TYPE_ID";
 
-    AspectTypeName aspectTypeName = AspectTypeName.of(projectId, location, aspectTypeId);
     AspectType.MetadataTemplate aspectField =
         AspectType.MetadataTemplate.newBuilder()
             // The name must follow regex ^(([a-zA-Z]{1})([\\w\\-_]{0,62}))$
@@ -56,16 +55,20 @@ public static void main(String[] args) throws Exception {
                     .build())
             .build();
     List<AspectType.MetadataTemplate> aspectFields = List.of(aspectField);
-    AspectType updatedAspectType = updateAspectType(aspectTypeName, aspectFields);
+    AspectType updatedAspectType =
+        updateAspectType(projectId, location, aspectTypeId, aspectFields);
     System.out.println("Successfully updated aspect type: " + updatedAspectType.getName());
   }
 
   public static AspectType updateAspectType(
-      AspectTypeName aspectTypeName, List<AspectType.MetadataTemplate> aspectFields)
+      String projectId,
+      String location,
+      String aspectTypeId,
+      List<AspectType.MetadataTemplate> aspectFields)
       throws Exception {
     AspectType aspectType =
         AspectType.newBuilder()
-            .setName(aspectTypeName.toString())
+            .setName(AspectTypeName.of(projectId, location, aspectTypeId).toString())
             .setDescription("updated description of the aspect type")
             .setMetadataTemplate(
                 AspectType.MetadataTemplate.newBuilder()

dataplex/snippets/src/test/java/dataplex/AspectTypeIT.java

@@ -20,8 +20,6 @@
 import static junit.framework.TestCase.assertNotNull;
 
 import com.google.cloud.dataplex.v1.AspectType;
-import com.google.cloud.dataplex.v1.AspectTypeName;
-import com.google.cloud.dataplex.v1.LocationName;
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.List;
@@ -33,8 +31,7 @@
 public class AspectTypeIT {
   private static final String ID = UUID.randomUUID().toString().substring(0, 8);
   private static final String LOCATION = "us-central1";
-  private static LocationName locationName;
-  private static AspectTypeName aspectTypeName;
+  private static final String aspectTypeId = "test-aspect-type" + ID;
   private static String expectedAspectType;
 
   private static final String PROJECT_ID = requireProjectIdEnvVar();
@@ -54,67 +51,63 @@ public static void checkRequirements() {
   @BeforeClass
   // Set-up code that will be executed before all tests
   public static void setUp() throws Exception {
-    String aspectTypeId = "test-aspect-type" + ID;
-    locationName = LocationName.of(PROJECT_ID, LOCATION);
-    aspectTypeName = AspectTypeName.of(PROJECT_ID, LOCATION, aspectTypeId);
     expectedAspectType =
         String.format(
             "projects/%s/locations/%s/aspectTypes/%s", PROJECT_ID, LOCATION, aspectTypeId);
     // Create Aspect Type resource that will be used in tests for "get", "list" and "update" methods
-    CreateAspectType.createAspectType(locationName, aspectTypeId, new ArrayList<>());
+    CreateAspectType.createAspectType(PROJECT_ID, LOCATION, aspectTypeId, new ArrayList<>());
   }
 
   @Test
-  public void listAspectTypes_returnsListContainingAspectTypeCreatedInSetUp() throws IOException {
-    List<AspectType> aspectTypes = ListAspectTypes.listAspectTypes(locationName);
+  public void testListAspectTypes() throws IOException {
+    List<AspectType> aspectTypes = ListAspectTypes.listAspectTypes(PROJECT_ID, LOCATION);
     assertThat(aspectTypes.stream().map(AspectType::getName)).contains(expectedAspectType);
   }
 
   @Test
-  public void getAspectType_returnsAspectTypeCreatedInSetUp() throws IOException {
-    AspectType aspectType = GetAspectType.getAspectType(aspectTypeName);
+  public void testGetAspectType() throws IOException {
+    AspectType aspectType = GetAspectType.getAspectType(PROJECT_ID, LOCATION, aspectTypeId);
     assertThat(aspectType.getName()).isEqualTo(expectedAspectType);
   }
 
   @Test
-  public void updateAspectType_returnsUpdatedAspectType() throws Exception {
-    AspectType aspectType = UpdateAspectType.updateAspectType(aspectTypeName, new ArrayList<>());
+  public void testUpdateAspectType() throws Exception {
+    AspectType aspectType =
+        UpdateAspectType.updateAspectType(PROJECT_ID, LOCATION, aspectTypeId, new ArrayList<>());
     assertThat(aspectType.getName()).isEqualTo(expectedAspectType);
   }
 
   @Test
-  public void createAspectType_returnsCreatedAspectType() throws Exception {
+  public void testCreateAspectType() throws Exception {
     String aspectTypeIdToCreate = "test-aspect-type" + UUID.randomUUID().toString().substring(0, 8);
-    AspectTypeName aspectTypeNameToCreate =
-        AspectTypeName.of(PROJECT_ID, LOCATION, aspectTypeIdToCreate);
     String expectedAspectTypeToCreate =
         String.format(
             "projects/%s/locations/%s/aspectTypes/%s", PROJECT_ID, LOCATION, aspectTypeIdToCreate);
 
     AspectType aspectType =
-        CreateAspectType.createAspectType(locationName, aspectTypeIdToCreate, new ArrayList<>());
+        CreateAspectType.createAspectType(
+            PROJECT_ID, LOCATION, aspectTypeIdToCreate, new ArrayList<>());
     // Clean-up created Aspect Type
-    DeleteAspectType.deleteAspectType(aspectTypeNameToCreate);
+    DeleteAspectType.deleteAspectType(PROJECT_ID, LOCATION, aspectTypeIdToCreate);
 
     assertThat(aspectType.getName()).isEqualTo(expectedAspectTypeToCreate);
   }
 
   @Test
-  public void deleteAspectType_executesTheCallWithoutException() throws Exception {
+  public void testDeleteAspectType() throws Exception {
     String aspectTypeIdToDelete = "test-aspect-type" + UUID.randomUUID().toString().substring(0, 8);
-    AspectTypeName aspectTypeNameToDelete =
-        AspectTypeName.of(PROJECT_ID, LOCATION, aspectTypeIdToDelete);
     // Create Aspect Type to be deleted
-    CreateAspectType.createAspectType(locationName, aspectTypeIdToDelete, new ArrayList<>());
+    CreateAspectType.createAspectType(
+        PROJECT_ID, LOCATION, aspectTypeIdToDelete, new ArrayList<>());
 
     // No exception means successful call
-    DeleteAspectType.deleteAspectType(aspectTypeNameToDelete);
+    DeleteAspectType.deleteAspectType(PROJECT_ID, LOCATION, aspectTypeIdToDelete);
   }
 
   @AfterClass
   // Clean-up code that will be executed after all tests
   public static void tearDown() throws Exception {
     // Clean-up Aspect Type resource created in setUp()
-    DeleteAspectType.deleteAspectType(aspectTypeName);
+    DeleteAspectType.deleteAspectType(PROJECT_ID, LOCATION, aspectTypeId);
   }
 }