List aspect types

List existing aspect types.

Code sample

Java

Before trying this sample, follow the Java setup instructions in the Dataplex Universal Catalog quickstart using client libraries. For more information, see the Dataplex Universal Catalog Java API reference documentation.

To authenticate to Dataplex Universal Catalog, set up Application Default Credentials. For more information, see Set up authentication for a local development environment.

import com.google.cloud.dataplex.v1.AspectType;
import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.LocationName;
import com.google.common.collect.ImmutableList;
import java.io.IOException;
import java.util.List;

public class ListAspectTypes {

  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<AspectType> aspectTypes = listAspectTypes(projectId, location);
    aspectTypes.forEach(
        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 {
    // Initialize client that will be used to send requests. This client only needs to be created
    // 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
      return ImmutableList.copyOf(listAspectTypesResponse.iterateAll());
    }
  }
}

Python

Before trying this sample, follow the Python setup instructions in the Dataplex Universal Catalog quickstart using client libraries. For more information, see the Dataplex Universal Catalog Python API reference documentation.

To authenticate to Dataplex Universal Catalog, set up Application Default Credentials. For more information, see Set up authentication for a local development environment.

from typing import List

from google.cloud import dataplex_v1


def list_aspect_types(project_id: str, location: str) -> List[dataplex_v1.AspectType]:
    """Method to list Aspect Types located in project_id and location"""

    # 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 Aspect Type location
        parent = f"projects/{project_id}/locations/{location}"
        results = client.list_aspect_types(parent=parent)
        return list(results)


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"

    aspect_types = list_aspect_types(project_id, location)
    for aspect_type in aspect_types:
        print(f"Aspect type name: {aspect_type.name}")

What's next

To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser.