Get aspect type

Retrieve an existing aspect type.

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.AspectTypeName;
import com.google.cloud.dataplex.v1.CatalogServiceClient;
import java.io.IOException;

public class GetAspectType {

  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 aspectTypeId = "MY_ASPECT_TYPE_ID";

    AspectType aspectType = getAspectType(projectId, location, aspectTypeId);
    System.out.println("Aspect type retrieved successfully: " + aspectType.getName());
  }

  // Method to retrieve Aspect Type located in projectId, location and with aspectTypeId
  public static AspectType getAspectType(String projectId, String location, String aspectTypeId)
      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()) {
      AspectTypeName aspectTypeName = AspectTypeName.of(projectId, location, aspectTypeId);
      return client.getAspectType(aspectTypeName);
    }
  }
}

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 google.cloud import dataplex_v1


def get_aspect_type(
    project_id: str, location: str, aspect_type_id: str
) -> dataplex_v1.AspectType:
    """Method to retrieve Aspect Type located in project_id, location and with aspect_type_id"""

    # 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
        name = (
            f"projects/{project_id}/locations/{location}/aspectTypes/{aspect_type_id}"
        )
        return client.get_aspect_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"
    aspect_type_id = "MY_ASPECT_TYPE_ID"

    aspect_type = get_aspect_type(project_id, location, aspect_type_id)
    print(f"Aspect type retrieved successfully: {aspect_type.name}")

What's next

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