Knowledge Catalog(旧称 Dataplex Universal Catalog)を使用すると、カスタム データソースからメタデータを取り込み、すべてのデータアセットを一元的なレジストリでカタログ化して管理できます。カスタム データソースを統合するには、アクセス権限、メタデータ スキーマ、個々のアセット レコードを定義するエントリ グループ、エントリタイプ、エントリを構成します。
統合プロセス
Knowledge Catalog にカスタム データソースを登録するには、次の 3 つの主要なコンポーネントが必要です。これらのコンポーネントは、次の順序で設定します。
エントリ グループを作成します。エントリ グループは、カスタム データレコードを保持する安全なコンテナです。アクセス権限とレコードの地理的位置(リージョン)を定義するフォルダと考えることができます。
エントリタイプを定義する。エントリタイプは、テンプレートまたはスキーマとして機能します。特定の種類のデータアセットに必要なメタデータ フィールド(データ所有者、更新頻度、品質スコアなど)を定義します。
カスタム エントリを作成します。エントリは、エントリ グループ フォルダ内のエントリタイプ テンプレートを使用して作成する個々のデータレコードまたはアセット自体(特定の独自ファイルやデータベース テーブルなど)です。
エントリ
エントリは、メタデータをキャプチャするデータアセットを表します。すべてのエントリはエントリタイプのインスタンスです。エントリのアスペクトに対する各オペレーションは、エントリタイプの必須アスペクトに準拠している必要があります。たとえば、エントリを作成するときに、エントリタイプで定義されているすべてのアスペクト タイプの値を指定する必要があります。エントリタイプで required としてマークされているエントリのアスペクトは削除できません。
エントリのカテゴリ
システム エントリ: Knowledge Catalog は、BigQuery データセットやテーブルなどの Google Cloudリソースのエントリを作成します。Knowledge Catalog が作成するエントリはシステム エントリと呼ばれます。Knowledge Catalog は、サポートされている Google Cloud システムからの継続的なメタデータ同期により、システム エントリを自動的に最新の状態に保ちます。
システム エントリに自動的に入力されるメタデータ(必須アスペクト)は変更できません。システム エントリの追加メタデータを追加または変更できるのは、オプションのアスペクトを使用する場合のみです。詳細については、アスペクトのカテゴリをご覧ください。
Knowledge Catalog API または Google Cloud コンソールからシステム エントリを直接削除することはできません。システム エントリを削除するには、元の Google Cloud サービスでソースリソースを削除します(たとえば、Vertex AI データセット、Dataform リポジトリ、BigQuery テーブルを削除します)。ソースリソースを削除すると、Knowledge Catalog はメタデータの同期中にエントリを自動的に削除します。
カスタム エントリ: カスタム リソース用に作成して管理できるエントリをカスタム エントリと呼びます。カスタム リソースは、 Google Cloud または外部(オンプレミスなど)でホストされている Google 以外のサービスのリソースです。
エントリ グループ
エントリ グループは、1 つ以上のエントリのコンテナです。エントリ グループを使用すると、メタデータのアクセス制御(グループ内のエントリを表示、追加、編集できるユーザーなど)とエントリのリージョン ロケーションを管理できます。エントリが参照する基になるデータへのアクセス権は付与されません。すべてのエントリ グループはプロジェクトに属し、Knowledge Catalog リソースの命名ガイドラインに準拠する必要があります。
エントリ グループのカテゴリ
システム エントリ グループ: Google Cloud リソースの場合、Knowledge Catalog は、リソースが存在するすべてのプロジェクトとロケーション(
@bigquery、@vertexai、@dataform、@pubsubなど)の各システムにエントリ グループを自動的に作成します。Knowledge Catalog はプラットフォーム全体のメタデータ取り込み機能として機能するため、プロジェクトで Dataplex API が有効になっていない場合でも、これらのエントリ グループを作成します。システム エントリ グループや、それらを表すentrygroupエントリを手動で削除することはできません。詳細については、このドキュメントのエントリ グループを削除するをご覧ください。カスタム エントリ グループ: カスタム リソース用に作成するエントリ グループ。
エントリタイプ
エントリタイプは、必須のアスペクト タイプのセットを使用して、このタイプのエントリに必要なメタデータを定義します。
必須アスペクト タイプはエントリにのみ指定できます。エントリの列には指定できません。特定のエントリタイプのエントリを作成する場合は、エントリタイプで指定されている必須のアスペクト タイプの値をすべて指定する必要があります。
エントリタイプ内で参照される必須アスペクト タイプは、エントリタイプと同じプロジェクトに属している必要があります。
エントリタイプのカテゴリ
カスタム エントリタイプ: 作成して管理するエントリタイプ。これらのエントリタイプを使用して、カスタム エントリを作成できます。
システム エントリタイプ: Knowledge Catalog はデフォルトでこれらのエントリタイプを提供します。システム エントリタイプは、再利用可能と制限付きにさらに分類されます。
次の表では、システム エントリタイプのカテゴリと、各カテゴリに Knowledge Catalog が提供するエントリタイプのリストを示します。
システム エントリタイプのカテゴリ 説明 Knowledge Catalog が提供するエントリタイプ 再利用可能なシステム エントリタイプ このエントリタイプを使用して、カスタム エントリを作成できます。 generic
制限付きシステム エントリタイプ これらは、Google Cloud リソースのエントリの作成など、システム用に予約されています。
これらのエントリタイプを使用してエントリを作成することはできませんが、これらのエントリタイプのエントリを編集して、オプションのアスペクトを追加することはできます。以下を含みます(ただしこれらに限定されません)。 analytics-hub-exchangeanalytics-hub-listingaspecttypebigquery-datasetbigquery-tablecloudsql-databasecloudsql-instancecloudsql-tableentrygroupentrytypesql-accessstoragestorage-bucketstorage-folder
カスタム エントリタイプは、特定のリージョン ロケーションで作成できます。またグローバル リソースとして作成することもできます。エントリタイプのロケーションは、適用範囲に影響します。詳細については、プロジェクトとロケーションの制約をご覧ください。
システム エントリタイプは常にグローバルであり、Knowledge Catalog はプロジェクト番号 655216118709(例: projects/655216118709/locations/global/entryTypes/bigquery-table)の Google 管理プロジェクトに保存します。
始める前に
エントリを管理してカスタム データソースを取り込む前に、このセクションで説明するタスクを完了していることを確認してください。
必要なロール
エントリの作成と管理に必要な権限を取得するには、リソースに対する次の IAM ロールの付与を管理者に依頼してください。
-
エントリ、エントリ グループ、エントリタイプに対する完全な権限セット: Dataplex Catalog 管理者(
roles/dataplex.catalogAdmin) -
エントリ、エントリ グループ、エントリタイプなど、Knowledge Catalog でメタデータ リソースを作成、管理する: Dataplex Catalog 編集者(
roles/dataplex.catalogEditor) -
エントリ関連のオペレーションに対する完全アクセス権: Dataplex エントリ / エントリリンク オーナー(
roles/dataplex.entryOwner) -
エントリ、エントリ グループ、エントリタイプ、およびそれらに関連付けられた IAM ポリシーを表示する: Dataplex Catalog 閲覧者(
roles/dataplex.catalogViewer) -
カスタム エントリを作成するときに、アスペクト タイプを使用して、そのタイプのアスペクトを作成する: Dataplex アスペクト タイプ ユーザー(
roles/dataplex.aspectTypeUser) -
エントリ グループを作成、管理する: Dataplex エントリ グループ オーナー(
roles/dataplex.entryGroupOwner) -
エントリタイプを作成、管理する: Dataplex エントリタイプ オーナー(
roles/dataplex.entryTypeOwner) -
エントリタイプを使用して、そのタイプのエントリを作成および変更する: Dataplex エントリタイプ ユーザー(
roles/dataplex.entryTypeUser)
ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。
必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。
詳細については、Knowledge Catalog の IAM ロールをご覧ください。
API を有効にする
Knowledge Catalog プロジェクトで Dataplex API を有効にします。新しい Google Cloud プロジェクトまたは BigQuery API が有効になっているプロジェクトを使用している場合、Dataplex API はデフォルトで有効になっています。
エントリ グループを作成する
コンソール
Google Cloud コンソールで、Knowledge Catalog の [メタデータのタイプ] ページに移動します。
[エントリ グループ] > [カスタム] タブをクリックします。
[作成] をクリックします。
[エントリ グループを作成する] ウィンドウで、次のように入力します。
- 省略可: [表示名] フィールドに、エントリ グループの表示名を入力します。
- エントリ グループ ID: エントリ グループの一意の ID を入力します。
- 省略可: [説明] フィールドに、エントリ グループの説明を入力します。
- ロケーション: ロケーションを選択します。エントリ グループの作成後にロケーションを変更することはできません。
省略可: [ラベル] セクションで、任意のラベルを Key-Value ペアとしてリソースに追加します。
- [ラベルを追加] をクリックします。
- [キー] フィールドにキーを入力します。
- [値] フィールドにキーの値を入力します。
- ラベルをさらに追加するには、[ラベルを追加] をクリックしてこの手順を繰り返します。
[保存] をクリックします。
gcloud
エントリ グループを作成するには、gcloud dataplex entry-groups create コマンドを使用します。
C#
C#
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある C# の設定手順を完了してください。詳細については、Knowledge Catalog C# API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Go
Go
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Go の設定手順を完了してください。詳細については、Knowledge Catalog Go API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
Java
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Java の設定手順を完了してください。詳細については、Knowledge Catalog Java API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Node.js
Node.js
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Node.js の設定手順を完了してください。詳細については、Knowledge Catalog Node.js API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Python
Python
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Python の設定手順を完了してください。詳細については、Knowledge Catalog Python API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Ruby
Ruby
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Ruby の設定手順を完了してください。詳細については、Knowledge Catalog Ruby API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
REST
エントリ グループを作成するには、entryGroups.Create メソッドを使用します。
エントリタイプを作成する
新しいソースを取り込むには、エントリタイプを作成する必要があります。
コンソール
Google Cloud コンソールで、Knowledge Catalog の [メタデータのタイプ] ページに移動します。
[エントリタイプ] > [カスタム] タブをクリックします。
[作成] をクリックします。
[エントリタイプの作成] ウィンドウで、次のように入力します。
- 省略可: [表示名] フィールドに、エントリタイプの表示名を入力します。
- エントリタイプ ID: エントリタイプの一意の ID を入力します。エントリタイプを作成した後に変更することはできません。
- 省略可: [説明] フィールドに、エントリタイプの説明を入力します。
- 省略可: [システム] フィールドにソースシステムを入力します。
- 省略可: [プラットフォーム] フィールドに、このタイプのエントリが属するプラットフォームを入力します。例:
Google Cloud - [ロケーション] フィールドで、ロケーションを選択します。エントリタイプを作成した後にロケーションを変更することはできません。
省略可: [タイプ エイリアス] セクションで、エントリタイプのデータ型を定義します。このデータ型は、エントリのクエリに使用できます。
- [タイプ エイリアスを追加] をクリックします。
- [タイプ エイリアス] フィールドでデータ型を選択します。タイプ エイリアスは複数追加できます。
[必須のアスペクト タイプ] セクションで、このエントリタイプに必須のアスペクト タイプを選択します。このタイプに基づいて作成された各エントリには、これらの必須のアスペクト タイプが割り当てられます。エントリタイプを作成した後に、必須のアスペクト タイプのリストを変更することはできません。
- [アスペクト タイプを選択] をクリックします。
- [アスペクトのタイプを選択] ウィンドウで、アスペクト タイプを選択します。
- [選択] をクリックします。
エントリから必須のアスペクトを削除することはできません。
省略可: [ラベル] セクションで、任意のラベルを Key-Value ペアとしてリソースに追加します。
- [ラベルを追加] をクリックします。
- [キー] フィールドにキーを入力します。
- [値] フィールドにキーの値を入力します。
- ラベルをさらに追加するには、[ラベルを追加] をクリックしてこの手順を繰り返します。
[保存] をクリックします。
gcloud
エントリタイプを作成するには、gcloud dataplex entry-types create コマンドを使用します。
C#
C#
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある C# の設定手順を完了してください。詳細については、Knowledge Catalog C# API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Go
Go
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Go の設定手順を完了してください。詳細については、Knowledge Catalog Go API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
Java
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Java の設定手順を完了してください。詳細については、Knowledge Catalog Java API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Node.js
Node.js
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Node.js の設定手順を完了してください。詳細については、Knowledge Catalog Node.js API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Python
Python
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Python の設定手順を完了してください。詳細については、Knowledge Catalog Python API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Ruby
Ruby
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Ruby の設定手順を完了してください。詳細については、Knowledge Catalog Ruby API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
REST
エントリタイプを作成するには、entryTypes.create メソッドを使用します。
カスタム エントリを作成する
カスタム エントリを作成する前に、エントリ グループとエントリタイプを作成していることを確認します。
コンソール
Google Cloud コンソールを使用してカスタム エントリを作成することはサポートされていません。代わりに、Google Cloud CLI または API を使用してください。
gcloud
カスタム エントリを作成するには、gcloud dataplex entries create コマンドを使用します。
C#
C#
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある C# の設定手順を完了してください。詳細については、Knowledge Catalog C# API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Go
Go
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Go の設定手順を完了してください。詳細については、Knowledge Catalog Go API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
Java
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Java の設定手順を完了してください。詳細については、Knowledge Catalog Java API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Python
Python
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Python の設定手順を完了してください。詳細については、Knowledge Catalog Python API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Ruby
Ruby
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Ruby の設定手順を完了してください。詳細については、Knowledge Catalog Ruby API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
REST
カスタム エントリを作成するには、entries.create メソッドを使用します。
カスタム エントリを作成したら、エントリにアスペクトを追加できます。詳細については、エントリにアスペクトを追加するをご覧ください。
BigQuery エントリ名
Dataplex API を介して BigQuery リソースを操作する場合は、エントリ グループ ID とエントリ ID に特定の形式を使用する必要があります。
- エントリ グループ ID:
@bigquery - エントリ ID:
bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
例
BigQuery テーブルが projects/test-project/datasets/test_dataset/tables/test_table の場合、完全修飾 Knowledge Catalog エントリ名は次のようになります。
projects/PROJECT_ID/locations/LOCATION_ID/entryGroups/@bigquery/entries/bigquery.googleapis.com/projects/test-project/datasets/test_dataset/tables/test_table
エントリ グループを管理する
このセクションでは、使用可能なエントリ グループのリスト表示、詳細表示、エントリ グループを更新、削除する方法について説明します。
使用可能なエントリ グループのリストを表示する
コンソール
Google Cloud コンソールで、Knowledge Catalog の [メタデータのタイプ] ページに移動します。
[エントリ グループ] タブをクリックします。
このページには、使用可能な Knowledge Catalog エントリ グループがすべて一覧表示されます。
カスタム エントリ グループを表示するには、[カスタム] タブをクリックします。[カスタム] タブの [カタログソース] 列には、リソースが存在する場所(Knowledge Catalog)が表示されます。
システム エントリ グループを表示するには、[システム] タブをクリックします。
カスタム エントリ グループとシステム エントリ グループの詳細については、このドキュメントのエントリ グループのカテゴリをご覧ください。
省略可: 選択したプロジェクトのエントリ グループのリストを表示するには、[カスタム] タブをクリックし、[すべてのプロジェクトから表示] をオフに切り替えます。
[すべてのプロジェクトから表示] 切り替えボタンはデフォルトでオンになっています。リストには、選択した組織の Knowledge Catalog リソースが含まれます。
gcloud
使用可能なエントリ グループのリストを表示するには、gcloud dataplex entry-groups list コマンドを使用します。
C#
C#
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある C# の設定手順を完了してください。詳細については、Knowledge Catalog C# API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Go
Go
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Go の設定手順を完了してください。詳細については、Knowledge Catalog Go API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
Java
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Java の設定手順を完了してください。詳細については、Knowledge Catalog Java API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Node.js
Node.js
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Node.js の設定手順を完了してください。詳細については、Knowledge Catalog Node.js API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Python
Python
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Python の設定手順を完了してください。詳細については、Knowledge Catalog Python API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Ruby
Ruby
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Ruby の設定手順を完了してください。詳細については、Knowledge Catalog Ruby API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
REST
使用可能なエントリ グループのリストを表示するには、entryGroups.list メソッドを使用します。
エントリ グループの詳細の表示
コンソール
Google Cloud コンソールで、Knowledge Catalog の [メタデータのタイプ] ページに移動します。
[エントリ グループ] タブをクリックします。
詳細を表示するエントリ グループをクリックします。
[エントリ グループの詳細] ページが開きます。選択したエントリ グループの表示名、エントリ グループ ID、説明、プロジェクト ID、ロケーション、ラベル、作成日、最終更新日などの情報にアクセスできます。
[サンプル エントリ] セクションには、選択したエントリ グループで最近作成された関連エントリが 10 個表示されます。
省略可: エントリ グループに関連するすべてのエントリを表示するには、[サンプル エントリ] セクションで [検索結果の関連エントリをすべて表示] をクリックします。
gcloud
エントリ グループの詳細を取得するには、gcloud dataplex entry-groups describe コマンドを使用します。
C#
C#
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある C# の設定手順を完了してください。詳細については、Knowledge Catalog C# API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Go
Go
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Go の設定手順を完了してください。詳細については、Knowledge Catalog Go API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
Java
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Java の設定手順を完了してください。詳細については、Knowledge Catalog Java API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Python
Python
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Python の設定手順を完了してください。詳細については、Knowledge Catalog Python API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Ruby
Ruby
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Ruby の設定手順を完了してください。詳細については、Knowledge Catalog Ruby API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
REST
エントリ グループの詳細を取得するには、entryGroups.get メソッドを使用します。
エントリ グループを更新する
カスタム エントリ グループを更新できます。システム エントリ グループは変更できません。
コンソール
Google Cloud コンソールで、Knowledge Catalog の [メタデータのタイプ] ページに移動します。
[エントリ グループ] > [カスタム] タブをクリックします。
更新するエントリ グループをクリックします。
[エントリ グループの詳細] ページで、[編集] をクリックします。
必要に応じて、表示名、説明、ラベルを編集します。
[保存] をクリックします。
gcloud
エントリ グループを更新するには、gcloud dataplex entry-groups update コマンドを使用します。
C#
C#
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある C# の設定手順を完了してください。詳細については、Knowledge Catalog C# API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Go
Go
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Go の設定手順を完了してください。詳細については、Knowledge Catalog Go API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
Java
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Java の設定手順を完了してください。詳細については、Knowledge Catalog Java API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Python
Python
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Python の設定手順を完了してください。詳細については、Knowledge Catalog Python API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Ruby
Ruby
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Ruby の設定手順を完了してください。詳細については、Knowledge Catalog Ruby API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
REST
エントリ グループを更新するには、entryGroups.patch メソッドを使用します。
エントリ グループを削除する
カスタム エントリ グループは削除できます。ただし、システム エントリ グループ(@bigquery、@vertexai、@dataform、@pubsub など、@ で始まる名前)や、それらを表す entrygroup エントリ(@vertexai_entry など)は削除できません。Knowledge Catalog はプラットフォーム全体のメタデータ取り込み機能として機能するため、プロジェクトで Dataplex API が無効になっている場合でも、これらのシステム リソースは表示されます。空のシステム エントリ グループと entrygroup エントリは、システム メタデータのみを含むシステム生成のプレースホルダであり、顧客データは保存されません。
同期されたリソース エントリをシステム エントリ グループから削除するには、元の Google Cloud サービスでソースリソースを削除します(たとえば、Vertex AI データセットまたは Dataform リポジトリを削除します)。ソースリソースを削除すると、Knowledge Catalog はメタデータの同期中に対応するエントリを自動的に削除します。
コンソール
Google Cloud コンソールで、Knowledge Catalog の [メタデータのタイプ] ページに移動します。
[エントリ グループ] > [カスタム] タブをクリックします。
削除するエントリ グループをクリックします。
[エントリ グループの詳細] ページで、[削除] をクリックします。表示されるメッセージを確認します。
gcloud
エントリ グループを削除するには、gcloud dataplex entry-groups delete コマンドを使用します。
C#
C#
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある C# の設定手順を完了してください。詳細については、Knowledge Catalog C# API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Go
Go
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Go の設定手順を完了してください。詳細については、Knowledge Catalog Go API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
Java
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Java の設定手順を完了してください。詳細については、Knowledge Catalog Java API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Node.js
Node.js
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Node.js の設定手順を完了してください。詳細については、Knowledge Catalog Node.js API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Python
Python
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Python の設定手順を完了してください。詳細については、Knowledge Catalog Python API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Ruby
Ruby
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Ruby の設定手順を完了してください。詳細については、Knowledge Catalog Ruby API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
REST
エントリ グループを削除するには、entryGroups.delete メソッドを使用します。
エントリタイプを管理する
このセクションでは、使用可能なエントリタイプのリスト表示、詳細表示、エントリ グループを更新、削除する方法について説明します。
使用可能なエントリタイプのリストを表示する
コンソール
Google Cloud コンソールで、Knowledge Catalog の [メタデータのタイプ] ページに移動します。
[エントリタイプ] タブをクリックします。
カスタム エントリタイプを表示するには、[カスタム] タブをクリックします。システム エントリタイプを表示するには、[システム] タブをクリックします。カスタム エントリタイプとシステム エントリタイプの詳細については、このドキュメントのエントリタイプのカテゴリをご覧ください。
省略可: 選択したプロジェクトのエントリタイプのリストを表示するには、[カスタム] タブをクリックし、[すべてのプロジェクトから表示] をオフに切り替えます。
[すべてのプロジェクトから表示] 切り替えボタンはデフォルトでオンになっています。リストには、すべてのプロジェクトのエントリタイプが含まれます。
gcloud
使用可能なエントリタイプのリストを表示するには、gcloud dataplex entry-types list コマンドを使用します。
C#
C#
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある C# の設定手順を完了してください。詳細については、Knowledge Catalog C# API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Go
Go
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Go の設定手順を完了してください。詳細については、Knowledge Catalog Go API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
Java
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Java の設定手順を完了してください。詳細については、Knowledge Catalog Java API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Python
Python
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Python の設定手順を完了してください。詳細については、Knowledge Catalog Python API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Ruby
Ruby
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Ruby の設定手順を完了してください。詳細については、Knowledge Catalog Ruby API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
REST
使用可能なエントリタイプのリストを表示するには、entryTypes.list メソッドを使用します。
エントリタイプの詳細を表示する
コンソール
Google Cloud コンソールで、Knowledge Catalog の [メタデータのタイプ] ページに移動します。
[エントリタイプ] > [カスタム] タブをクリックします。
詳細を表示するエントリタイプをクリックします。
エントリタイプの詳細ページが開きます。選択したエントリタイプの表示名、エントリタイプ ID、説明、プロジェクト ID、ロケーション、プラットフォーム、システム、タイプ エイリアス、ラベル、作成日、最終更新日などの情報にアクセスできます。
省略可: 最近作成された関連エントリのリスト(10 件)を表示するには、[サンプル エントリ] タブをクリックします。
省略可: エントリ グループに関連するすべてのエントリを表示するには、[サンプル エントリ] タブをクリックし、[検索結果の関連エントリをすべて表示] をクリックします。
gcloud
エントリタイプの詳細を取得するには、gcloud dataplex entry-types describe コマンドを使用します。
C#
C#
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある C# の設定手順を完了してください。詳細については、Knowledge Catalog C# API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Go
Go
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Go の設定手順を完了してください。詳細については、Knowledge Catalog Go API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
Java
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Java の設定手順を完了してください。詳細については、Knowledge Catalog Java API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Python
Python
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Python の設定手順を完了してください。詳細については、Knowledge Catalog Python API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Ruby
Ruby
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Ruby の設定手順を完了してください。詳細については、Knowledge Catalog Ruby API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
REST
エントリタイプの詳細を取得するには、entryTypes.get メソッドを使用します。
エントリタイプを更新する
コンソール
Google Cloud コンソールで、Knowledge Catalog の [メタデータのタイプ] ページに移動します。
[エントリタイプ] > [カスタム] タブをクリックします。
更新するエントリタイプをクリックします。
[エントリタイプの詳細] ページで、[編集] をクリックします。
必要に応じて、表示名、説明、システム、プラットフォーム、タイプ エイリアス、ラベルを編集します。
[保存] をクリックします。
gcloud
エントリタイプを更新するには、gcloud dataplex entry-types update コマンドを使用します。
C#
C#
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある C# の設定手順を完了してください。詳細については、Knowledge Catalog C# API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Go
Go
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Go の設定手順を完了してください。詳細については、Knowledge Catalog Go API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
Java
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Java の設定手順を完了してください。詳細については、Knowledge Catalog Java API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Node.js
Node.js
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Node.js の設定手順を完了してください。詳細については、Knowledge Catalog Node.js API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Python
Python
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Python の設定手順を完了してください。詳細については、Knowledge Catalog Python API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Ruby
Ruby
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Ruby の設定手順を完了してください。詳細については、Knowledge Catalog Ruby API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
REST
エントリタイプを更新するには、entryTypes.patch メソッドを使用します。
エントリタイプの削除
コンソール
Google Cloud コンソールで、Knowledge Catalog の [メタデータのタイプ] ページに移動します。
[エントリタイプ] > [カスタム] タブをクリックします。
削除するエントリタイプをクリックします。
[エントリタイプの詳細] ページで、[削除] をクリックします。表示されるメッセージを確認します。
gcloud
エントリタイプを削除するには、gcloud dataplex entry-types delete コマンドを使用します。
C#
C#
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある C# の設定手順を完了してください。詳細については、Knowledge Catalog C# API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Go
Go
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Go の設定手順を完了してください。詳細については、Knowledge Catalog Go API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
Java
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Java の設定手順を完了してください。詳細については、Knowledge Catalog Java API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Node.js
Node.js
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Node.js の設定手順を完了してください。詳細については、Knowledge Catalog Node.js API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Python
Python
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Python の設定手順を完了してください。詳細については、Knowledge Catalog Python API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Ruby
Ruby
このサンプルを試す前に、クライアント ライブラリを使用した Knowledge Catalog のクイックスタートにある Ruby の設定手順を完了してください。詳細については、Knowledge Catalog Ruby API のリファレンス ドキュメントをご覧ください。
Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
REST
エントリタイプを削除するには、entryTypes.delete メソッドを使用します。
次のステップ
- Knowledge Catalog でリソースを検索する方法を確認する。
- アスペクトを管理してメタデータを拡充する方法を確認する。
- Knowledge Catalog にメタデータをインポートする方法を確認する。
- Knowledge Catalog のメタデータの詳細を確認する。