List entry groups
Stay organized with collections
Save and categorize content based on your preferences.
List existing entry groups.
Code sample
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],[],[[["\u003cp\u003eThis content provides code samples in Java and Python for listing existing entry groups within Google Cloud Dataplex.\u003c/p\u003e\n"],["\u003cp\u003eThe code samples demonstrate how to use the Dataplex client libraries to retrieve a list of entry groups for a specified project and location.\u003c/p\u003e\n"],["\u003cp\u003eBoth Java and Python examples emphasize the importance of setting up Application Default Credentials (ADC) for authentication and provide links to relevant documentation.\u003c/p\u003e\n"],["\u003cp\u003eBefore running the provided code, it is needed to replace \u003ccode\u003eMY_PROJECT_ID\u003c/code\u003e and \u003ccode\u003eMY_LOCATION\u003c/code\u003e with the real values.\u003c/p\u003e\n"],["\u003cp\u003eThe content also provides a link to the Google Cloud sample browser for searching and filtering code samples for other Google Cloud products.\u003c/p\u003e\n"]]],[],null,["# List entry groups\n\nList existing entry groups.\n\nCode sample\n-----------\n\n### Java\n\n\nBefore trying this sample, follow the Java setup instructions in the\n[Dataplex Universal Catalog quickstart using\nclient libraries](/dataplex/docs/reference/libraries).\n\n\nFor more information, see the\n[Dataplex Universal Catalog Java API\nreference documentation](/java/docs/reference/google-cloud-dataplex/latest/overview).\n\n\nTo authenticate to Dataplex Universal Catalog, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n import com.google.cloud.dataplex.v1.https://cloud.google.com/java/docs/reference/google-cloud-dataplex/latest/com.google.cloud.dataplex.v1.CatalogServiceClient.html;\n import com.google.cloud.dataplex.v1.https://cloud.google.com/java/docs/reference/google-cloud-dataplex/latest/com.google.cloud.dataplex.v1.EntryGroup.html;\n import com.google.cloud.dataplex.v1.https://cloud.google.com/java/docs/reference/google-cloud-dataplex/latest/com.google.cloud.dataplex.v1.LocationName.html;\n import com.google.common.collect.ImmutableList;\n import java.io.IOException;\n import java.util.List;\n\n public class ListEntryGroups {\n\n public static void main(String[] args) throws IOException {\n // TODO(developer): Replace these variables before running the sample.\n String projectId = \"MY_PROJECT_ID\";\n // Available locations: https://cloud.google.com/dataplex/docs/locations\n String location = \"MY_LOCATION\";\n\n List\u003cEntryGroup\u003e entryGroups = listEntryGroups(projectId, location);\n entryGroups.forEach(\n entryGroup -\u003e System.out.println(\"Entry group name: \" + entryGroup.getName()));\n }\n\n // Method to list Entry Groups located in projectId and location\n public static List\u003cEntryGroup\u003e listEntryGroups(String projectId, String location)\n throws IOException {\n // Initialize client that will be used to send requests. This client only needs to be created\n // once, and can be reused for multiple requests.\n try (https://cloud.google.com/java/docs/reference/google-cloud-dataplex/latest/com.google.cloud.dataplex.v1.CatalogServiceClient.html client = https://cloud.google.com/java/docs/reference/google-cloud-dataplex/latest/com.google.cloud.dataplex.v1.CatalogServiceClient.html.create()) {\n https://cloud.google.com/java/docs/reference/google-cloud-dataplex/latest/com.google.cloud.dataplex.v1.LocationName.html locationName = https://cloud.google.com/java/docs/reference/google-cloud-dataplex/latest/com.google.cloud.dataplex.v1.LocationName.html.of(projectId, location);\n https://cloud.google.com/java/docs/reference/google-cloud-dataplex/latest/com.google.cloud.dataplex.v1.CatalogServiceClient.html.https://cloud.google.com/java/docs/reference/google-cloud-dataplex/latest/com.google.cloud.dataplex.v1.CatalogServiceClient.ListEntryGroupsPagedResponse.html listEntryGroupsResponse =\n client.listEntryGroups(locationName);\n // Paging is implicitly handled by .iterateAll(), all results will be returned\n return ImmutableList.copyOf(listEntryGroupsResponse.iterateAll());\n }\n }\n }\n\n### Python\n\n\nBefore trying this sample, follow the Python setup instructions in the\n[Dataplex Universal Catalog quickstart using\nclient libraries](/dataplex/docs/reference/libraries).\n\n\nFor more information, see the\n[Dataplex Universal Catalog Python API\nreference documentation](/python/docs/reference/dataplex/latest).\n\n\nTo authenticate to Dataplex Universal Catalog, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n from typing import List\n\n from google.cloud import https://cloud.google.com/python/docs/reference/dataplex/latest/\n\n\n def list_entry_groups(project_id: str, location: str) -\u003e List[dataplex_v1.EntryGroup]:\n \"\"\"Method to list Entry Groups located in project_id and location\"\"\"\n\n # Initialize client that will be used to send requests across threads. This\n # client only needs to be created once, and can be reused for multiple requests.\n # After completing all of your requests, call the \"__exit__()\" method to safely\n # clean up any remaining background resources. Alternatively, use the client as\n # a context manager.\n with https://cloud.google.com/python/docs/reference/dataplex/latest/.https://cloud.google.com/python/docs/reference/dataplex/latest/google.cloud.dataplex_v1.services.catalog_service.CatalogServiceClient.html() as client:\n # The resource name of the Entry Group location\n parent = f\"projects/{project_id}/locations/{location}\"\n results = client.list_entry_groups(parent=parent)\n return list(results)\n\n\n if __name__ == \"__main__\":\n # TODO(developer): Replace these variables before running the sample.\n project_id = \"MY_PROJECT_ID\"\n # Available locations: https://cloud.google.com/dataplex/docs/locations\n location = \"MY_LOCATION\"\n\n entry_groups = list_entry_groups(project_id, location)\n for entry_group in entry_groups:\n print(f\"Entry group name: {entry_group.name}\")\n\nWhat's next\n-----------\n\n\nTo search and filter code samples for other Google Cloud products, see the\n[Google Cloud sample browser](/docs/samples?product=dataplex)."]]