命名 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

這個值必須是專案 ID 或專案編號，可從 Google Cloud 控制台取得。舉例來說，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} 的命名規範有所不同：

  • 最多可包含 4000 個半形字元。

  • 請根據 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。

對於程序、執行作業和歷程事件等資料歷程資源，變數 {PROCESS_ID}、{RUN_ID} 和 {LINEAGE_EVENT_ID} 必須符合下列規範：

  • 最多可包含 200 個半形字元。

  • 只能包含英文字母 (會區分大小寫)、數字、連字號、底線、冒號和半形句號。

BigQuery 項目名稱

透過 Knowledge Catalog 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