エントリのルックアップ

既存のエントリを取得します。

コードサンプル

Java

このサンプルを試す前に、クライアント ライブラリを使用した Dataplex のクイックスタートにある Java の設定手順を行ってください。 詳細については、Dataplex Java API のリファレンス ドキュメントをご覧ください。

Dataplex への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。

import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.Entry;
import com.google.cloud.dataplex.v1.EntryName;
import com.google.cloud.dataplex.v1.EntryView;
import com.google.cloud.dataplex.v1.LookupEntryRequest;
import java.io.IOException;

public class LookupEntry {

  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";
    String entryId = "MY_ENTRY_ID";

    Entry entry = lookupEntry(projectId, location, entryGroupId, entryId);
    System.out.println("Entry retrieved successfully: " + entry.getName());
    entry
        .getAspectsMap()
        .keySet()
        .forEach(aspectKey -> System.out.println("Retrieved aspect for entry: " + aspectKey));
  }

  // Method to retrieve Entry located in projectId, location, entryGroupId and with entryId
  // When Entry is created in Dataplex for example for BigQuery table,
  // access permissions might differ between Dataplex and source system.
  // "Lookup" method checks permissions in source system.
  // Please also refer how to get an Entry, which checks permissions in Dataplex.
  public static Entry lookupEntry(
      String projectId, String location, String entryGroupId, String entryId) 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()) {
      String projectLocation = String.format("projects/%s/locations/%s", projectId, location);
      LookupEntryRequest lookupEntryRequest =
          LookupEntryRequest.newBuilder()
              // The project to which the request should be attributed
              .setName(projectLocation)
              // The resource name of the Entry
              .setEntry(EntryName.of(projectId, location, entryGroupId, entryId).toString())
              // View determines which Aspects are returned with the Entry.
              // For all available options, see:
              // https://cloud.google.com/sdk/gcloud/reference/dataplex/entries/lookup#--view
              .setView(EntryView.FULL)
              // Following 2 lines will be ignored, because "View" is set to FULL.
              // Their purpose is to demonstrate how to filter the Aspects returned for Entry
              // when "View" is set to CUSTOM.
              .addAspectTypes("projects/dataplex-types/locations/global/aspectTypes/generic")
              .addPaths("my_path")
              .build();
      return client.lookupEntry(lookupEntryRequest);
    }
  }
}

Python

このサンプルを試す前に、クライアント ライブラリを使用した Dataplex のクイックスタートにある Python の設定手順を行ってください。 詳細については、Dataplex Python API のリファレンス ドキュメントをご覧ください。

Dataplex への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。

from google.cloud import dataplex_v1


def lookup_entry(
    project_id: str, location: str, entry_group_id: str, entry_id: str
) -> dataplex_v1.Entry:
    """Method to retrieve Entry located in project_id, location, entry_group_id and with entry_id

    When Entry is created in Dataplex for example for BigQuery table,
    access permissions might differ between Dataplex and source system.
    "Lookup" method checks permissions in source system.
    Please also refer how to get an Entry, which checks permissions in Dataplex.
    """

    # 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:
        lookup_entry_request = dataplex_v1.LookupEntryRequest(
            # The project to which the request should be attributed
            name=f"projects/{project_id}/locations/{location}",
            # The resource name of the Entry
            entry=f"projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}",
            # View determines which Aspects are returned with the Entry.
            # For all available options, see:
            # https://cloud.google.com/sdk/gcloud/reference/dataplex/entries/lookup#--view
            view=dataplex_v1.EntryView.FULL,
            # Following 2 lines will be ignored, because "View" is set to FULL.
            # Their purpose is to demonstrate how to filter the Aspects returned for Entry
            # when "View" is set to CUSTOM.
            aspect_types=[
                "projects/dataplex-types/locations/global/aspectTypes/generic"
            ],
            paths=["my_path"],
        )
        return client.lookup_entry(request=lookup_entry_request)


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"
    entry_id = "MY_ENTRY_ID"

    entry = lookup_entry(project_id, location, entry_group_id, entry_id)
    print(f"Entry retrieved successfully: {entry.name}")
    for aspect_key in entry.aspects.keys():
        print(f"Retrieved aspect for entry: {aspect_key}")

次のステップ

他の Google Cloud プロダクトに関連するコードサンプルの検索およびフィルタ検索を行うには、Google Cloud のサンプルをご覧ください。