feat(dataplex): add code samples for Entry Group (#9567)

jacspa96 · Jacek Spalinski · web-flow · commit 446856bb4851 · 2024-10-11T15:03:22.000-07:00
* feat(dataplex): add sample for list Entry Groups

* feat(dataplex): add sample for get Entry Group

* feat(dataplex): add sample for delete Entry Group

* feat(dataplex): add sample for create Entry Group

* feat(dataplex): add sample for update Entry Group

* feat(dataplex): add integration tests for Entry Group

* 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

* feat(dataplex): add comment explaining paging handling

---------

Co-authored-by: Jacek Spalinski &lt;jspa@google.com&gt;
diff --git a/dataplex/snippets/src/main/java/dataplex/CreateEntryGroup.java b/dataplex/snippets/src/main/java/dataplex/CreateEntryGroup.java
@@ -0,0 +1,53 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package dataplex;
+
+// [START dataplex_create_entry_group]
+import com.google.cloud.dataplex.v1.CatalogServiceClient;
+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 {
+    // TODO(developer): Replace these variables before running the sample.
+    String projectId = "MY_PROJECT_ID";
+    // Available locations: https://cloud.google.com/dataplex/docs/locations
+    String location = "MY_LOCATION";
+    String entryGroupId = "MY_ENTRY_GROUP_ID";
+
+    EntryGroup createdEntryGroup = createEntryGroup(projectId, location, entryGroupId);
+    System.out.println("Successfully created entry group: " + createdEntryGroup.getName());
+  }
+
+  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.
+    try (CatalogServiceClient client = CatalogServiceClient.create()) {
+      return client.createEntryGroupAsync(locationName, entryGroup, entryGroupId).get();
+    }
+  }
+}
+// [END dataplex_create_entry_group]
diff --git a/dataplex/snippets/src/main/java/dataplex/DeleteEntryGroup.java b/dataplex/snippets/src/main/java/dataplex/DeleteEntryGroup.java
@@ -0,0 +1,50 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package dataplex;
+
+// [START dataplex_delete_entry_group]
+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 {
+    // TODO(developer): Replace these variables before running the sample.
+    String projectId = "MY_PROJECT_ID";
+    // Available locations: https://cloud.google.com/dataplex/docs/locations
+    String location = "MY_LOCATION";
+    String entryGroupId = "MY_ENTRY_GROUP_ID";
+
+    deleteEntryGroup(projectId, location, entryGroupId);
+    System.out.println("Successfully deleted entry group");
+  }
+
+  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.
+    try (CatalogServiceClient client = CatalogServiceClient.create()) {
+      client.deleteEntryGroupAsync(entryGroupName).get();
+    }
+  }
+}
+// [END dataplex_delete_entry_group]
diff --git a/dataplex/snippets/src/main/java/dataplex/GetEntryGroup.java b/dataplex/snippets/src/main/java/dataplex/GetEntryGroup.java
@@ -0,0 +1,52 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package dataplex;
+
+// [START dataplex_get_entry_group]
+import com.google.cloud.dataplex.v1.CatalogServiceClient;
+import com.google.cloud.dataplex.v1.EntryGroup;
+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 {
+    // TODO(developer): Replace these variables before running the sample.
+    String projectId = "MY_PROJECT_ID";
+    // Available locations: https://cloud.google.com/dataplex/docs/locations
+    String location = "MY_LOCATION";
+    String entryGroupId = "MY_ENTRY_GROUP_ID";
+
+    EntryGroup entryGroup = getEntryGroup(projectId, location, entryGroupId);
+    System.out.println("Entry group retrieved successfully: " + entryGroup.getName());
+  }
+
+  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.
+    try (CatalogServiceClient client = CatalogServiceClient.create()) {
+      return client.getEntryGroup(entryGroupName);
+    }
+  }
+}
+// [END dataplex_get_entry_group]
diff --git a/dataplex/snippets/src/main/java/dataplex/ListEntryGroups.java b/dataplex/snippets/src/main/java/dataplex/ListEntryGroups.java
@@ -0,0 +1,57 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package dataplex;
+
+// [START dataplex_list_entry_groups]
+import com.google.cloud.dataplex.v1.CatalogServiceClient;
+import com.google.cloud.dataplex.v1.EntryGroup;
+import com.google.cloud.dataplex.v1.LocationName;
+import com.google.common.collect.ImmutableList;
+import java.io.IOException;
+import java.util.List;
+
+// Sample to list Entry Groups
+public class ListEntryGroups {
+
+  public static void main(String[] args) throws IOException {
+    // TODO(developer): Replace these variables before running the sample.
+    String projectId = "MY_PROJECT_ID";
+    // Available locations: https://cloud.google.com/dataplex/docs/locations
+    String location = "MY_LOCATION";
+
+    List<EntryGroup> entryGroups = listEntryGroups(projectId, location);
+    entryGroups.forEach(
+        entryGroup -> System.out.println("Entry group name: " + entryGroup.getName()));
+  }
+
+  public static List<EntryGroup> listEntryGroups(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.ListEntryGroupsPagedResponse listEntryGroupsResponse =
+          client.listEntryGroups(locationName);
+      // Paging is implicitly handled by .iterateAll(), all results will be returned
+      return ImmutableList.copyOf(listEntryGroupsResponse.iterateAll());
+    }
+  }
+}
+// [END dataplex_list_entry_groups]
diff --git a/dataplex/snippets/src/main/java/dataplex/UpdateEntryGroup.java b/dataplex/snippets/src/main/java/dataplex/UpdateEntryGroup.java
@@ -0,0 +1,62 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package dataplex;
+
+// [START dataplex_update_entry_group]
+import com.google.cloud.dataplex.v1.CatalogServiceClient;
+import com.google.cloud.dataplex.v1.EntryGroup;
+import com.google.cloud.dataplex.v1.EntryGroupName;
+import com.google.protobuf.FieldMask;
+
+// Sample to update Entry Group
+public class UpdateEntryGroup {
+
+  public static void main(String[] args) throws Exception {
+    // TODO(developer): Replace these variables before running the sample.
+    String projectId = "MY_PROJECT_ID";
+    // Available locations: https://cloud.google.com/dataplex/docs/locations
+    String location = "MY_LOCATION";
+    String entryGroupId = "MY_ENTRY_GROUP_ID";
+
+    EntryGroup updatedEntryGroup = updateEntryGroup(projectId, location, entryGroupId);
+    System.out.println("Successfully updated entry group: " + updatedEntryGroup.getName());
+  }
+
+  public static EntryGroup updateEntryGroup(String projectId, String location, String entryGroupId)
+      throws Exception {
+    EntryGroup entryGroup =
+        EntryGroup.newBuilder()
+            .setName(EntryGroupName.of(projectId, location, entryGroupId).toString())
+            .setDescription("updated description of the entry group")
+            .build();
+
+    // Update mask specifies which fields will be updated.
+    // If empty mask is given, all modifiable fields from the request will be used for update.
+    // If update mask is specified as "*" it is treated as full update,
+    // that means fields not present in the request will be emptied.
+    FieldMask updateMask = FieldMask.newBuilder().addPaths("description").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.
+    try (CatalogServiceClient client = CatalogServiceClient.create()) {
+      return client.updateEntryGroupAsync(entryGroup, updateMask).get();
+    }
+  }
+}
+// [END dataplex_update_entry_group]
diff --git a/dataplex/snippets/src/test/java/dataplex/EntryGroupIT.java b/dataplex/snippets/src/test/java/dataplex/EntryGroupIT.java
@@ -0,0 +1,109 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package dataplex;
+
+import static com.google.common.truth.Truth.assertThat;
+import static junit.framework.TestCase.assertNotNull;
+
+import com.google.cloud.dataplex.v1.EntryGroup;
+import java.io.IOException;
+import java.util.List;
+import java.util.UUID;
+import org.junit.AfterClass;
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+public class EntryGroupIT {
+  private static final String ID = UUID.randomUUID().toString().substring(0, 8);
+  private static final String LOCATION = "us-central1";
+  private static final String entryGroupId = "test-entry-group" + ID;
+  private static String expectedEntryGroup;
+
+  private static final String PROJECT_ID = requireProjectIdEnvVar();
+
+  private static String requireProjectIdEnvVar() {
+    String value = System.getenv("GOOGLE_CLOUD_PROJECT");
+    assertNotNull(
+        "Environment variable GOOGLE_CLOUD_PROJECT is required to perform these tests.", value);
+    return value;
+  }
+
+  @BeforeClass
+  public static void checkRequirements() {
+    requireProjectIdEnvVar();
+  }
+
+  @BeforeClass
+  // Set-up code that will be executed before all tests
+  public static void setUp() throws Exception {
+    expectedEntryGroup =
+        String.format(
+            "projects/%s/locations/%s/entryGroups/%s", PROJECT_ID, LOCATION, entryGroupId);
+    // Create Entry Group resource that will be used in tests for "get", "list" and "update" methods
+    CreateEntryGroup.createEntryGroup(PROJECT_ID, LOCATION, entryGroupId);
+  }
+
+  @Test
+  public void testListEntryGroups() throws IOException {
+    List<EntryGroup> entryGroups = ListEntryGroups.listEntryGroups(PROJECT_ID, LOCATION);
+    assertThat(entryGroups.stream().map(EntryGroup::getName)).contains(expectedEntryGroup);
+  }
+
+  @Test
+  public void testGetEntryGroup() throws IOException {
+    EntryGroup entryGroup = GetEntryGroup.getEntryGroup(PROJECT_ID, LOCATION, entryGroupId);
+    assertThat(entryGroup.getName()).isEqualTo(expectedEntryGroup);
+  }
+
+  @Test
+  public void testUpdateEntryGroup() throws Exception {
+    EntryGroup entryGroup = UpdateEntryGroup.updateEntryGroup(PROJECT_ID, LOCATION, entryGroupId);
+    assertThat(entryGroup.getName()).isEqualTo(expectedEntryGroup);
+  }
+
+  @Test
+  public void testCreateEntryGroup() throws Exception {
+    String entryGroupIdToCreate = "test-entry-group" + UUID.randomUUID().toString().substring(0, 8);
+    String expectedEntryGroupToCreate =
+        String.format(
+            "projects/%s/locations/%s/entryGroups/%s", PROJECT_ID, LOCATION, entryGroupIdToCreate);
+
+    EntryGroup entryGroup =
+        CreateEntryGroup.createEntryGroup(PROJECT_ID, LOCATION, entryGroupIdToCreate);
+    // Clean-up created Entry Group
+    DeleteEntryGroup.deleteEntryGroup(PROJECT_ID, LOCATION, entryGroupIdToCreate);
+
+    assertThat(entryGroup.getName()).isEqualTo(expectedEntryGroupToCreate);
+  }
+
+  @Test
+  public void testDeleteEntryGroup() throws Exception {
+    String entryGroupIdToDelete = "test-entry-group" + UUID.randomUUID().toString().substring(0, 8);
+    // Create Entry Group to be deleted
+    CreateEntryGroup.createEntryGroup(PROJECT_ID, LOCATION, entryGroupIdToDelete);
+
+    // No exception means successful call
+    DeleteEntryGroup.deleteEntryGroup(PROJECT_ID, LOCATION, entryGroupIdToDelete);
+  }
+
+  @AfterClass
+  // Clean-up code that will be executed after all tests
+  public static void tearDown() throws Exception {
+    // Clean-up Entry Group resource created in setUp()
+    DeleteEntryGroup.deleteEntryGroup(PROJECT_ID, LOCATION, entryGroupId);
+  }
+}
