feat(dataplex): add code samples for Entry Types and Groups (#12749)

* feat(dataplex): add sample for list Entry Types

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

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

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

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

* feat(dataplex): add integration test for Entry Types

* 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 test for Entry Groups

* feat(dataplex): opt out from not required python builds

* feat(dataplex): use default noxfile config

---------

Co-authored-by: Jacek Spalinski <jspa@google.com>

Author: jacspa96

dataplex/snippets/create_entry_group.py

@@ -0,0 +1,49 @@
+# 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.
+
+# [START dataplex_create_entry_group]
+from google.cloud import dataplex_v1
+
+
+# Method to create Entry Group located in project_id, location and with entry_group_id
+def create_entry_group(
+    project_id: str, location: str, entry_group_id: str
+) -> dataplex_v1.EntryGroup:
+    # Initialize client that will be used to send requests across threads. This
+    # client only needs to be created once, and can be reused for multiple requests.
+    # After completing all of your requests, call the "__exit__()" method to safely
+    # clean up any remaining background resources. Alternatively, use the client as
+    # a context manager.
+    with dataplex_v1.CatalogServiceClient() as client:
+        # The resource name of the Entry Group location
+        parent = f"projects/{project_id}/locations/{location}"
+        entry_group = dataplex_v1.EntryGroup(
+            description="description of the entry group"
+        )
+        create_operation = client.create_entry_group(
+            parent=parent, entry_group=entry_group, entry_group_id=entry_group_id
+        )
+        return create_operation.result(60)
+
+
+if __name__ == "__main__":
+    # TODO(developer): Replace these variables before running the sample.
+    project_id = "MY_PROJECT_ID"
+    # Available locations: https://cloud.google.com/dataplex/docs/locations
+    location = "MY_LOCATION"
+    entry_group_id = "MY_ENTRY_GROUP_ID"
+
+    created_entry_group = create_entry_group(project_id, location, entry_group_id)
+    print(f"Successfully created entry group: {created_entry_group.name}")
+# [END dataplex_create_entry_group]

dataplex/snippets/create_entry_type.py

@@ -0,0 +1,58 @@
+# 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.
+
+# [START dataplex_create_entry_type]
+from google.cloud import dataplex_v1
+
+
+# Method to create Entry Type located in project_id, location and with entry_type_id
+def create_entry_type(
+    project_id: str, location: str, entry_type_id: str
+) -> dataplex_v1.EntryType:
+    # Initialize client that will be used to send requests across threads. This
+    # client only needs to be created once, and can be reused for multiple requests.
+    # After completing all of your requests, call the "__exit__()" method to safely
+    # clean up any remaining background resources. Alternatively, use the client as
+    # a context manager.
+    with dataplex_v1.CatalogServiceClient() as client:
+        # The resource name of the Entry Type location
+        parent = f"projects/{project_id}/locations/{location}"
+        entry_type = dataplex_v1.EntryType(
+            description="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.
+            required_aspects=[
+                dataplex_v1.EntryType.AspectInfo(
+                    # Example of system aspect type.
+                    # It is also possible to specify custom aspect type.
+                    type="projects/dataplex-types/locations/global/aspectTypes/generic"
+                )
+            ],
+        )
+        create_operation = client.create_entry_type(
+            parent=parent, entry_type=entry_type, entry_type_id=entry_type_id
+        )
+        return create_operation.result(60)
+
+
+if __name__ == "__main__":
+    # TODO(developer): Replace these variables before running the sample.
+    project_id = "MY_PROJECT_ID"
+    # Available locations: https://cloud.google.com/dataplex/docs/locations
+    location = "MY_LOCATION"
+    entry_type_id = "MY_ENTRY_TYPE_ID"
+
+    created_entry_type = create_entry_type(project_id, location, entry_type_id)
+    print(f"Successfully created entry type: {created_entry_type.name}")
+# [END dataplex_create_entry_type]

dataplex/snippets/delete_entry_group.py

@@ -0,0 +1,43 @@
+# 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.
+
+# [START dataplex_delete_entry_group]
+from google.cloud import dataplex_v1
+
+
+# Method to delete Entry Group located in project_id, location and with entry_group_id
+def delete_entry_group(project_id: str, location: str, entry_group_id: str) -> None:
+    # Initialize client that will be used to send requests across threads. This
+    # client only needs to be created once, and can be reused for multiple requests.
+    # After completing all of your requests, call the "__exit__()" method to safely
+    # clean up any remaining background resources. Alternatively, use the client as
+    # a context manager.
+    with dataplex_v1.CatalogServiceClient() as client:
+        # The resource name of the Entry Type
+        name = (
+            f"projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}"
+        )
+        client.delete_entry_group(name=name)
+
+
+if __name__ == "__main__":
+    # TODO(developer): Replace these variables before running the sample.
+    project_id = "MY_PROJECT_ID"
+    # Available locations: https://cloud.google.com/dataplex/docs/locations
+    location = "MY_LOCATION"
+    entry_group_id = "MY_ENTRY_GROUP_ID"
+
+    delete_entry_group(project_id, location, entry_group_id)
+    print("Successfully deleted entry group")
+# [END dataplex_delete_entry_group]

dataplex/snippets/delete_entry_type.py

@@ -0,0 +1,41 @@
+# 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.
+
+# [START dataplex_delete_entry_type]
+from google.cloud import dataplex_v1
+
+
+# Method to delete Entry Type located in project_id, location and with entry_type_id
+def delete_entry_type(project_id: str, location: str, entry_type_id: str) -> None:
+    # Initialize client that will be used to send requests across threads. This
+    # client only needs to be created once, and can be reused for multiple requests.
+    # After completing all of your requests, call the "__exit__()" method to safely
+    # clean up any remaining background resources. Alternatively, use the client as
+    # a context manager.
+    with dataplex_v1.CatalogServiceClient() as client:
+        # The resource name of the Entry Type
+        name = f"projects/{project_id}/locations/{location}/entryTypes/{entry_type_id}"
+        client.delete_entry_type(name=name)
+
+
+if __name__ == "__main__":
+    # TODO(developer): Replace these variables before running the sample.
+    project_id = "MY_PROJECT_ID"
+    # Available locations: https://cloud.google.com/dataplex/docs/locations
+    location = "MY_LOCATION"
+    entry_type_id = "MY_ENTRY_TYPE_ID"
+
+    delete_entry_type(project_id, location, entry_type_id)
+    print("Successfully deleted entry type")
+# [END dataplex_delete_entry_type]

dataplex/snippets/entry_group_test.py

@@ -0,0 +1,93 @@
+# 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.
+import os
+
+import uuid
+
+from google.api_core.retry import Retry
+
+import pytest
+
+import create_entry_group
+import delete_entry_group
+import get_entry_group
+import list_entry_groups
+import update_entry_group
+
+PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")
+LOCATION = "us-central1"
+ENTRY_GROUP_ID = f"test-entry-group-{str(uuid.uuid4()).split('-')[0]}"
+EXPECTED_ENTRY_GROUP = (
+    f"projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}"
+)
+
+
+@pytest.fixture(autouse=True, scope="session")
+def setup_and_teardown_entry_group() -> None:
+    try:
+        # Create Entry Group resource that will be used in tests for "get", "list" and "update" methods
+        create_entry_group.create_entry_group(PROJECT_ID, LOCATION, ENTRY_GROUP_ID)
+        yield
+    finally:
+        # Clean-up Entry Group resource created above
+        delete_entry_group.delete_entry_group(PROJECT_ID, LOCATION, ENTRY_GROUP_ID)
+
+
+@Retry()
+def test_list_entry_groups() -> None:
+    entry_groups = list_entry_groups.list_entry_groups(PROJECT_ID, LOCATION)
+    assert EXPECTED_ENTRY_GROUP in [entry_group.name for entry_group in entry_groups]
+
+
+@Retry()
+def test_get_entry_group() -> None:
+    entry_group = get_entry_group.get_entry_group(PROJECT_ID, LOCATION, ENTRY_GROUP_ID)
+    assert EXPECTED_ENTRY_GROUP == entry_group.name
+
+
+@Retry()
+def test_update_entry_group() -> None:
+    entry_group = update_entry_group.update_entry_group(
+        PROJECT_ID, LOCATION, ENTRY_GROUP_ID
+    )
+    assert EXPECTED_ENTRY_GROUP == entry_group.name
+
+
+@Retry()
+def test_create_entry_group() -> None:
+    entry_group_id_to_create = f"test-entry-group-{str(uuid.uuid4()).split('-')[0]}"
+    expected_entry_group_to_create = f"projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{entry_group_id_to_create}"
+    try:
+        entry_group = create_entry_group.create_entry_group(
+            PROJECT_ID, LOCATION, entry_group_id_to_create
+        )
+        assert expected_entry_group_to_create == entry_group.name
+    finally:
+        # Clean-up created Entry Group
+        delete_entry_group.delete_entry_group(
+            PROJECT_ID, LOCATION, entry_group_id_to_create
+        )
+
+
+@Retry()
+def test_delete_entry_group() -> None:
+    entry_group_id_to_delete = f"test-entry-group-{str(uuid.uuid4()).split('-')[0]}"
+    # Create Entry Group to be deleted
+    create_entry_group.create_entry_group(
+        PROJECT_ID, LOCATION, entry_group_id_to_delete
+    )
+    # No exception means successful call
+    delete_entry_group.delete_entry_group(
+        PROJECT_ID, LOCATION, entry_group_id_to_delete
+    )

dataplex/snippets/entry_type_test.py

@@ -0,0 +1,89 @@
+# 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.
+import os
+
+import uuid
+
+from google.api_core.retry import Retry
+
+import pytest
+
+import create_entry_type
+import delete_entry_type
+import get_entry_type
+import list_entry_types
+import update_entry_type
+
+PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")
+LOCATION = "us-central1"
+ENTRY_TYPE_ID = f"test-entry-type-{str(uuid.uuid4()).split('-')[0]}"
+EXPECTED_ENTRY_TYPE = (
+    f"projects/{PROJECT_ID}/locations/{LOCATION}/entryTypes/{ENTRY_TYPE_ID}"
+)
+
+
+@pytest.fixture(autouse=True, scope="session")
+def setup_and_teardown_entry_type() -> None:
+    try:
+        # Create Entry Type resource that will be used in tests for "get", "list" and "update" methods
+        create_entry_type.create_entry_type(PROJECT_ID, LOCATION, ENTRY_TYPE_ID)
+        yield
+    finally:
+        # Clean-up Entry Type resource created above
+        delete_entry_type.delete_entry_type(PROJECT_ID, LOCATION, ENTRY_TYPE_ID)
+
+
+@Retry()
+def test_list_entry_types() -> None:
+    entry_types = list_entry_types.list_entry_types(PROJECT_ID, LOCATION)
+    assert EXPECTED_ENTRY_TYPE in [entry_type.name for entry_type in entry_types]
+
+
+@Retry()
+def test_get_entry_type() -> None:
+    entry_type = get_entry_type.get_entry_type(PROJECT_ID, LOCATION, ENTRY_TYPE_ID)
+    assert EXPECTED_ENTRY_TYPE == entry_type.name
+
+
+@Retry()
+def test_update_entry_type() -> None:
+    entry_type = update_entry_type.update_entry_type(
+        PROJECT_ID, LOCATION, ENTRY_TYPE_ID
+    )
+    assert EXPECTED_ENTRY_TYPE == entry_type.name
+
+
+@Retry()
+def test_create_entry_type() -> None:
+    entry_type_id_to_create = f"test-entry-type-{str(uuid.uuid4()).split('-')[0]}"
+    expected_entry_type_to_create = f"projects/{PROJECT_ID}/locations/{LOCATION}/entryTypes/{entry_type_id_to_create}"
+    try:
+        entry_type = create_entry_type.create_entry_type(
+            PROJECT_ID, LOCATION, entry_type_id_to_create
+        )
+        assert expected_entry_type_to_create == entry_type.name
+    finally:
+        # Clean-up created Entry Type
+        delete_entry_type.delete_entry_type(
+            PROJECT_ID, LOCATION, entry_type_id_to_create
+        )
+
+
+@Retry()
+def test_delete_entry_type() -> None:
+    entry_type_id_to_delete = f"test-entry-type-{str(uuid.uuid4()).split('-')[0]}"
+    # Create Entry Type to be deleted
+    create_entry_type.create_entry_type(PROJECT_ID, LOCATION, entry_type_id_to_delete)
+    # No exception means successful call
+    delete_entry_type.delete_entry_type(PROJECT_ID, LOCATION, entry_type_id_to_delete)