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

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

Knowledge Catalog のリソースには次のものがあります。

  • エントリ グループ

  • エントリ

  • エントリのタイプ

  • アスペクト タイプ

  • エントリリンク

  • メタデータ ジョブ

  • メタデータ フィード

  • 用語集

  • 用語集のカテゴリ

  • 用語集の用語

  • データ プロダクト

  • データドメイン

  • リネージ プロセス

  • リネージ実行

  • リネージ イベント

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

リソースの命名形式

リソースごとの形式は次のとおりです。

  • エントリ グループ: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryGroups/{ENTRY_GROUP_ID}

  • エントリ: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}

  • エントリのタイプ: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryTypes/{ENTRY_TYPE_ID}

  • アスペクト タイプ: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/aspectTypes/{ASPECT_TYPE_ID}

  • エントリリンク: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryGroups/{ENTRY_GROUP_ID}/entryLinks/{ENTRY_LINK_ID}

  • メタデータ ジョブ: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/metadataJobs/{METADATA_JOB_ID}

  • メタデータ フィード: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/metadataFeeds/{METADATA_FEED_ID}

  • 用語集: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/glossaries/{GLOSSARY_ID}

  • 用語集のカテゴリ: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/glossaries/{GLOSSARY_ID}/categories/{GLOSSARY_CATEGORY_ID}

  • 用語集の用語: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/glossaries/{GLOSSARY_ID}/terms/{GLOSSARY_TERM_ID}

  • データ プロダクト: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/dataProducts/{DATA_PRODUCT_ID}

  • データドメイン: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/dataDomains/{DATA_DOMAIN_ID}

  • プロセス: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/processes/{PROCESS_ID}

  • 実行: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/processes/{PROCESS_ID}/runs/{RUN_ID}

  • リネージ イベント: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/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 は、リソースパスの最後のセグメントです。

ほとんどのリソース(エントリ グループ、エントリのタイプ、アスペクト タイプ、エントリリンク、 メタデータ ジョブ、メタデータ フィード、用語集、用語集のカテゴリ、用語集の用語、 データ プロダクト、データドメイン)の場合、 {ENTRY_GROUP_ID}{ENTRY_TYPE_ID}{ASPECT_TYPE_ID}{ENTRY_LINK_ID}{METADATA_JOB_ID}{METADATA_FEED_ID}{GLOSSARY_ID}{GLOSSARY_CATEGORY_ID}{GLOSSARY_TERM_ID}{DATA_PRODUCT_ID}{DATA_DOMAIN_ID} などの変数は、次のガイドラインに準拠する必要があります。

  • 先頭は小文字でなければなりません。

  • 1 ~ 63 文字で構成されます。

  • 小文字、数字、ハイフン、アンダースコアのみを使用します。

  • 末尾は数字または小文字でなければなりません。

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

  • 最大 4,000 文字です。

  • 完全なリソース名に基づくエントリ ID 形式を使用します。 Google Cloud 完全なリソース名に基づきます。 形式は、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 です。

プロセス、実行、リネージ イベントなどのデータリネージ リソースの場合、 変数 {PROCESS_ID}{RUN_ID}、および {LINEAGE_EVENT_ID} は次のガイドラインに準拠する必要があります。

  • 最大 200 文字です。

  • 文字(大文字と小文字を区別)、数字、ハイフン、アンダースコア、コロン、ピリオドのみを使用します。

BigQuery エントリ名

ナレッジ カタログ 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_NAME}/entryGroups/@bigquery/entries/bigquery.googleapis.com/projects/test-project/datasets/test_dataset/tables/test_table