Knowledge Catalog リソースの名前付けに関するガイドライン

Google Cloud リソースは、Google Cloud内で作成または使用するコンポーネントです。これらのリソースは、プラットフォームで実行されるアプリケーションとシステムの構成要素となります。

一般的な Google Cloud リソースの命名の詳細については、リソース名をご覧ください。

リソースの命名形式

次の表に、Knowledge Catalog リソースの完全なリソース名の形式を示します。

リソース 完全なリソース名の形式
エントリ グループ projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}
Entry projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}
エントリタイプ projects/{PROJECT_ID}/locations/{LOCATION}/entryTypes/{ENTRY_TYPE_ID}
アスペクト タイプ projects/{PROJECT_ID}/locations/{LOCATION}/aspectTypes/{ASPECT_TYPE_ID}
エントリリンク projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}/entryLinks/{ENTRY_LINK_ID}
メタデータ ジョブ projects/{PROJECT_ID}/locations/{LOCATION}/metadataJobs/{METADATA_JOB_ID}
メタデータ フィード projects/{PROJECT_ID}/locations/{LOCATION}/metadataFeeds/{METADATA_FEED_ID}
用語集 projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}
用語集のカテゴリ projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}/categories/{GLOSSARY_CATEGORY_ID}
用語集の用語 projects/{PROJECT_ID}/locations/{LOCATION}/glossaries/{GLOSSARY_ID}/terms/{GLOSSARY_TERM_ID}
データ プロダクト projects/{PROJECT_ID}/locations/{LOCATION}/dataProducts/{DATA_PRODUCT_ID}
データドメイン projects/{PROJECT_ID}/locations/{LOCATION}/dataDomains/{DATA_DOMAIN_ID}
リネージ プロセス projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}
リネージの実行 projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}/runs/{RUN_ID}
リネージ イベント projects/{PROJECT_ID}/locations/{LOCATION}/processes/{PROCESS_ID}/runs/{RUN_ID}/lineageEvents/{LINEAGE_EVENT_ID}

リソース名のコンポーネント

以降のセクションでは、各コンポーネントの内訳について説明します。

プロジェクト ID

値は、 Google Cloud コンソールから利用可能なプロジェクト ID またはプロジェクト番号にする必要があります。たとえば、my-cool-project はプロジェクト ID で、123456789123 はプロジェクト番号です。

ロケーション

値は、サポートされている Knowledge Catalog のロケーションのいずれかにする必要があります。使用可能なロケーションのリストについては、Knowledge Catalog のロケーションをご覧ください。

リソース ID

リソースパスには、各リソースとその親リソースの固有識別子（ID）セグメントが階層に含まれています。以降のセクションでは、各タイプのリソース ID の命名ガイドラインと形式要件について説明します。

標準リソース ID

エントリ ID とデータリネージ リソース ID を除き、{ENTRY_GROUP_ID} や {GLOSSARY_ID} などのすべてのリソース ID 変数は、次のガイドラインに準拠する必要があります。

  • 先頭は小文字でなければなりません。
  • 1 ～ 63 文字の長さであること。
  • 使用できるのは、英小文字、数字、ハイフン、アンダースコアのみです。
  • 末尾は数字または英小文字にしてください。

システム エントリ グループ

エントリ ID

{ENTRY_ID} の命名ガイドラインは異なります。

  • 4,000 文字以内であること。

  • Google Cloudの完全なリソース名に基づくエントリ ID 形式を使用します。形式は、API サービス名部分に接頭辞の二重スラッシュがないリソースの完全なリソース名です。これにより、関連付けられたリソース名を使用してエントリを取得できます。

    次に例を示します。

    • Looker インスタンスの完全なリソース名が //looker.googleapis.com/projects/my-project/locations/us-central1/instances/my-instance の場合、推奨される {ENTRY_ID} は looker.googleapis.com/projects/my-project/locations/us-central1/instances/my-instance です。

データリネージのリソース ID

データリネージ リソースは、データ変換オペレーションの階層を表します。

  • プロセス ID（{PROCESS_ID}）: データ変換の定義（特定の SQL クエリや ETL パイプラインなど）を識別します。
  • 実行 ID（{RUN_ID}）: 親プロセスの単一の実行インスタンスを識別します。
  • リネージ イベント ID（{LINEAGE_EVENT_ID}）: 実行中に発生したソースとターゲット間の個別のデータ移動イベントを識別します。

API を使用してカスタム リネージ リソースを作成する場合、変数 {PROCESS_ID}、{RUN_ID}、{LINEAGE_EVENT_ID} は次のガイドラインに準拠する必要があります。

  • 200 文字以内であること。
  • 使用できるのは、英字（大文字と小文字を区別）、数字、ハイフン、アンダースコア、コロン、ドットのみです。

自動リネージ（BigQuery クエリ、Managed Service for Apache Spark、OpenLineage の取り込みなど）の場合、Knowledge Catalog はこれらの ID を自動的に生成します。

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}/entryGroups/@bigquery/entries/bigquery.googleapis.com/projects/test-project/datasets/test_dataset/tables/test_table