エントリの一覧表示

既存のエントリを一覧表示します。

コードサンプル

JavaPython

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

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

import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.Entry;
import com.google.cloud.dataplex.v1.EntryGroupName;
import com.google.cloud.dataplex.v1.ListEntriesRequest;
import com.google.common.collect.ImmutableList;
import java.io.IOException;
import java.util.List;

public class ListEntries {

  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";

    List<Entry> entries = listEntries(projectId, location, entryGroupId);
    entries.forEach(aspectType -> System.out.println("Entry name: " + aspectType.getName()));
  }

  // Method to list Entries located in projectId, location and entryGroupId
  public static List<Entry> listEntries(String projectId, String location, String entryGroupId)
      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()) {
      ListEntriesRequest listEntriesRequest =
          ListEntriesRequest.newBuilder()
              .setParent(EntryGroupName.of(projectId, location, entryGroupId).toString())
              // A filter on the entries to return. Filters are case-sensitive.
              // You can filter the request by the following fields:
              // * entry_type
              // * entry_source.display_name
              // To learn more about filters in general, see:
              // https://cloud.google.com/sdk/gcloud/reference/topic/filters
              .setFilter("entry_type=projects/dataplex-types/locations/global/entryTypes/generic")
              .build();
      CatalogServiceClient.ListEntriesPagedResponse listEntriesResponse =
          client.listEntries(listEntriesRequest);
      // Paging is implicitly handled by .iterateAll(), all results will be returned
      return ImmutableList.copyOf(listEntriesResponse.iterateAll());
    }
  }
}

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

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

from typing import List

from google.cloud import dataplex_v1


def list_entries(
    project_id: str, location: str, entry_group_id: str
) -> List[dataplex_v1.Entry]:
    """Method to list Entries located in project_id, location and entry_group_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 Entries location
        parent = (
            f"projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}"
        )
        list_entries_request = dataplex_v1.ListEntriesRequest(
            parent=parent,
            # A filter on the entries to return. Filters are case-sensitive.
            # You can filter the request by the following fields:
            # * entry_type
            # * entry_source.display_name
            # To learn more about filters in general, see:
            # https://cloud.google.com/sdk/gcloud/reference/topic/filters
            filter="entry_type=projects/dataplex-types/locations/global/entryTypes/generic",
        )

        results = client.list_entries(request=list_entries_request)
        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"
    entry_group_id = "MY_ENTRY_GROUP_ID"

    entries = list_entries(project_id, location, entry_group_id)
    for entry in entries:
        print(f"Entry name: {entry.name}")

次のステップ

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