使用自訂管道匯入中繼資料

本文說明如何使用中繼資料匯入 API 方法和自己的管道，將第三方系統的中繼資料匯入 Knowledge Catalog (舊稱 Dataplex Universal Catalog)。Knowledge Catalog 中繼資料包含項目及其切面。

如果想改用 Google Cloud代管的自動化調度管理管道，擷取及匯入中繼資料，建議使用代管連線管道。使用代管連線管道時，您必須自備連接器，用於擷取中繼資料，並以中繼資料匯入 API 方法可做為輸入內容的格式 (中繼資料匯入檔案) 產生輸出內容。接著，您可以使用 Workflows 調度 pipeline 工作。

您可以執行下列類型的中繼資料匯入工作：

• 完整同步處理項目，並逐步匯入其切面。支援自訂項目。
• 僅匯入新增的面向。支援屬於自訂項目和系統項目的切面。如果是自訂項目，您可以修改選用和必要部分。如果是系統項目，您可以修改選用項目。

大致步驟

如要使用中繼資料匯入 API 匯入中繼資料，請按照下列高階步驟操作：

1. 決定工作範圍。

   此外，您也會瞭解 Knowledge Catalog 如何套用比較邏輯，以及項目和切面的同步模式。

2. 建立一或多個中繼資料匯入檔案，定義要匯入的資料。

3. 將中繼資料匯入檔案儲存在 Cloud Storage bucket。

4. 執行中繼資料匯入工作。

本頁步驟假設您熟悉 Knowledge Catalog 中繼資料概念，包括項目群組、項目類型和切面類型。詳情請參閱「關於 Knowledge Catalog 中的中繼資料」。

事前準備

匯入中繼資料前，請先完成本節中的工作。

必要的角色

為確保Knowledge Catalog 服務帳戶具備存取 Cloud Storage bucket 的必要權限，請要求管理員將 Storage 物件檢視者 (roles/storage.objectViewer) IAM 角色和 bucket 的 storage.buckets.get 權限授予 Knowledge Catalog 服務帳戶。

如要取得管理中繼資料匯入工作的權限，請要求管理員授予您下列 IAM 角色：

• 在完整項目同步中繼資料工作中，修改項目及其切面：
  • 在項目類型或定義項目類型的專案中，具備Dataplex 項目類型使用者 (roles/dataplex.entryTypeUser) 角色
  • 切面類型或定義切面類型的專案具備 Dataplex 切面類型使用者 (roles/dataplex.aspectTypeUser) 角色
• 修改僅限切面的中繼資料工作中必要切面：
  • 在項目類型或定義項目類型的專案中，具備Dataplex 項目類型使用者 (roles/dataplex.entryTypeUser) 角色
  • 切面類型或定義切面類型的專案具備 Dataplex 切面類型使用者 (roles/dataplex.aspectTypeUser) 角色
• 修改僅限切面的中繼資料工作中的選用切面：切面類型或定義切面類型的專案，須具備Dataplex 切面類型使用者 (roles/dataplex.aspectTypeUser) 角色。請注意，在僅限切面的中繼資料工作中修改選用切面時，您不需要相關聯項目類型的權限。
• 建立中繼資料匯入工作：
  • 專案或資源的 Dataplex 項目群組匯入者 (roles/dataplex.entryGroupImporter)
  • 專案或資源的 Dataplex 項目和 EntryLink 擁有者 (roles/dataplex.entryOwner)
• 查看中繼資料工作：專案的 Dataplex 中繼資料工作檢視者 (roles/dataplex.metadataJobViewer)
• 建立、查看及取消中繼資料工作：專案的 Dataplex 中繼資料工作擁有者 (roles/dataplex.metadataJobOwner)

如要進一步瞭解如何授予角色，請參閱「管理專案、資料夾和組織的存取權」。

您或許也能透過自訂角色或其他預先定義的角色，取得必要權限。

建立 Google Cloud 資源

準備下列 Google Cloud 資源：

1. 為要匯入的項目建立項目群組。
2. 為要匯入的切面建立切面類型。
3. 為要匯入的項目建立項目類型。
4. 如果您執行的是僅限切面的中繼資料工作，請為要匯入的切面建立項目。
5. 建立 Cloud Storage bucket，用於儲存中繼資料匯入檔案。

中繼資料匯入工作的組成部分

匯入中繼資料時，請考量中繼資料工作的下列元件：

• 工作範圍：要納入工作的項目群組、項目類型和切面類型。
• 同步處理模式：工作中的項目和切面更新方式。
• 中繼資料匯入檔案：定義工作中項目和切面設定值的檔案。您可以在同一項中繼資料工作中，提供多個中繼資料匯入檔案。將檔案儲存到 Cloud Storage。
• 比較邏輯：Knowledge Catalog 如何判斷要修改哪些項目和切面。

工作範圍

工作範圍定義了要納入中繼資料匯入工作的項目群組、項目類型和切面類型。匯入中繼資料時，您會修改屬於工作範圍內資源的項目和面向。

如要定義工作範圍，請遵循下列準則：

• 項目群組：指定要納入工作的一或多個項目群組。這項工作只會修改屬於這些項目群組的項目和切面。項目群組和工作必須位於相同區域。

• 項目類型：指定要納入工作的一或多個項目類型。這項工作只會修改屬於這些項目類型的項目和切面。項目類型的位置必須與工作位置相符，或項目類型必須為全域。

• 切面類型：指定要納入工作的一或多個切面類型。工作只會修改屬於這些切面類型的切面。切面類型的位置必須與工作位置相符，或切面類型必須為全域。

  注意： 中繼資料工作不支援匯入 data-rules 和 data-quality-rule-template 類型的切面。

工作範圍必須包含您在中繼資料匯入檔案中指定的所有項目類型和切面類型。

建立中繼資料工作時，您必須指定工作範圍。

同步處理模式

同步模式會指定中繼資料匯入工作中，項目和切面的更新方式。您必須為項目和切面提供同步模式。視您要匯入的資源而定，系統支援下列同步模式組合。

目標	項目同步模式	顯示比例同步模式	結果
匯入項目及其切面	FULL	INCREMENTAL	工作範圍內的所有項目都會修改。 如果項目存在於 Knowledge Catalog，但未包含在中繼資料匯入檔案中，則執行中繼資料工作時，系統會刪除該項目。 只有在中繼資料匯入檔案的 updateMask 欄位和 aspectKeys 欄位中包含切面的參照時，系統才會修改切面。請參閱「匯入項目的結構」。
僅匯入特徵	NONE	INCREMENTAL	如果切面屬於工作範圍，且中繼資料匯入檔案在 aspectKeys 欄位中參照切面，系統就會修改切面。請參閱「匯入項目的結構」。 工作範圍內項目所屬的其他中繼資料不會遭到修改。

建立中繼資料工作時，您必須指定同步處理模式。

中繼資料匯入檔案

中繼資料匯入檔案是您要修改的項目和切面的集合。它定義了要為屬於這些項目和切面的所有欄位設定的值。您必須先準備好檔案，才能執行中繼資料匯入工作。

請遵守以下通則：

• 您可以在同一項中繼資料工作中，提供多個中繼資料匯入檔案。

• 執行完整項目同步中繼資料工作時，您在檔案中提供的項目會完全取代工作範圍內任何資源的所有現有項目。也就是說，您必須為工作中的所有項目提供值，而不只是要新增或更新的值。如要取得專案中目前的項目清單，做為起始點，請使用 entries.list API 方法。

  注意： 如果項目存在於 Knowledge Catalog，但未包含在中繼資料匯入檔案，執行中繼資料工作時，系統會刪除該項目。如果中繼資料匯入檔案不含任何資料，系統會刪除屬於工作範圍的所有項目和切面。

• 您必須提供中繼資料匯入檔案，做為中繼資料工作的一部分。如要刪除工作範圍內項目的所有現有資料，請提供空白的中繼資料匯入檔案。

• 檔案中包含的所有項目和切面，都必須屬於您在工作範圍內定義的項目群組、項目類型和切面類型。

請按照下列各節的詳細指南，建立中繼資料匯入檔案。

檔案結構

中繼資料匯入檔案中的每一行都包含一個 JSON 物件，對應一個匯入項目。匯入項目是一種物件，用於描述要修改的項目值及其附加切面。

您可以在單一中繼資料匯入檔案中提供多個匯入項目。不過，請勿在中繼資料工作中多次提供相同的匯入項目。請使用換行字元 (0x0a) 分隔每個匯入項目。

中繼資料匯入檔案中，每個匯入項目之間都有換行字元，如下例所示：

{ "entry": { "name": "entry 1", #Information about entry 1 }
{ "entry": { "name": "entry 2", #Information about entry 2 }

匯入項目的結構

中繼資料匯入檔案中的每個匯入項目都可以包含下列欄位 (請參閱 ImportItem)。 以下範例已設定換行格式，方便閱讀，但儲存檔案時，請只在每個匯入項目後方加入換行字元。請勿在單一匯入項目的欄位之間加入換行符號。

{
  "entry": {
    "name": "ENTRY_NAME",
    "entryType": "ENTRY_TYPE",
    "entrySource": {
      "resource": "RESOURCE",
      "system": "SYSTEM",
      "platform": "PLATFORM",
      "displayName": "DISPLAY_NAME",
      "description": "DESCRIPTION",
      "createTime": "ENTRY_CREATE_TIMESTAMP",
      "updateTime": "ENTRY_UPDATE_TIMESTAMP"
    },
    "aspects": {
      "ASPECT": {
        "data": {
          "KEY": "VALUE"
        },
        "aspectSource": {
          "createTime": "ASPECT_CREATE_TIMESTAMP",
          "updateTime": "ASPECT_UPDATE_TIMESTAMP"
        }
      },
      # Additional aspect maps
    },
    "parentEntry": "PARENT_ENTRY",
    "fullyQualifiedName": "FULLY_QUALIFIED_NAME"
  },
  "updateMask": "UPDATE_MASK_FIELDS",
  "aspectKeys": [
    "ASPECT_KEY",
    # Additional aspect keys
  ],
}

更改下列內容：

• entry：項目及其附加切面的相關資訊。在僅限切面的中繼資料匯入工作中，Knowledge Catalog 會忽略項目的所有選填欄位，但切面對應除外。

  • ENTRY_NAME：項目的相對資源名稱，格式為 projects/PROJECT_ID_OR_NUMBER/locations/LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entries/ENTRY_ID。
  • ENTRY_TYPE：用於建立這項項目的項目類型相對資源名稱，格式為 projects/PROJECT_ID_OR_NUMBER/locations/LOCATION_ID/entryTypes/ENTRY_TYPE_ID。
  • entrySource：來源系統中，有關項目所代表資料資源的資訊：
    • RESOURCE：來源系統中的資源名稱。
    • SYSTEM：來源系統的名稱。
    • PLATFORM：來源系統所在的平台。
    • DISPLAY_NAME：容易使用的顯示名稱。
    • DESCRIPTION：項目說明。
    • ENTRY_CREATE_TIMESTAMP：在來源系統中建立項目的時間。
    • ENTRY_UPDATE_TIMESTAMP：項目在來源系統中更新的時間。

  • aspects：附加至項目的切面。aspect 物件及其資料稱為面向圖。

    • ASPECT：附加至項目的切面。請根據切面附加至項目的方式，採用下列其中一種格式：

      • 如果切面直接附加至項目，請提供切面類型的相對資源名稱，格式為 PROJECT_ID_OR_NUMBER.LOCATION_ID.ASPECT_TYPE_ID。
      • 如果切面附加至項目的路徑，請提供切面類型的路徑，格式為 PROJECT_ID_OR_NUMBER.LOCATION_ID.ASPECT_TYPE_ID@PATH。

    • KEY 和 VALUE：切面的內容，根據切面類型中繼資料範本而定。內容必須以 UTF-8 格式編碼。欄位大小上限為 120 KB。data 字典為必要項目，即使空白也必須提供。

    • ASPECT_CREATE_TIMESTAMP：在來源系統中建立切面的時間。

    • ASPECT_UPDATE_TIMESTAMP：在來源系統中更新切面的時間。

  • PARENT_ENTRY：父項項目的資源名稱。

  • FULLY_QUALIFIED_NAME：可由外部系統參照的項目名稱。請參閱「完整名稱」。

• UPDATE_MASK_FIELDS：要更新的欄位，路徑相對於 Entry 資源。請以半形逗號分隔各個欄位。

  在完整項目同步工作中，Knowledge Catalog 會納入項目中所有可修改欄位的路徑，包括切面。建立或重新建立項目時，系統會忽略 updateMask 欄位。

  在中繼資料工作 (僅限切面) 中，請將這個值設為 aspects。

• ASPECT_KEY：要修改的面向。支援下列語法：

  • ASPECT_TYPE_REFERENCE：比對直接附加至項目的切面類型。
  • ASPECT_TYPE_REFERENCE@PATH：比對切面類型和指定路徑。
  • ASPECT_TYPE_REFERENCE@*：比對所有路徑的切面類型。
  • *@PATH：比對指定路徑上的所有切面類型。

  將 ASPECT_TYPE_REFERENCE 替換為切面類型的參照，格式為 PROJECT_ID_OR_NUMBER.LOCATION_ID.ASPECT_TYPE_ID。

  在完整項目同步工作中，如果將這個欄位留空，系統會視為指定指定項目中存在的那些切面。Knowledge Catalog 會隱含新增項目所有必要切面的鍵。

檔案相關規定

中繼資料匯入檔案必須符合下列規定：

• 檔案必須採用 JSON Lines 格式，也就是以換行符號分隔的 JSON 檔案。請使用換行字元 (0x0a) 分隔每個匯入項目。
• 檔案必須使用 UTF-8 字元編碼。
• 支援的副檔名為 .jsonl 和 .json。
• 每個中繼資料匯入檔案的大小不得超過 1 GiB。中繼資料工作中所有資料的大小總和上限為 3 GB。包括與工作相關聯的所有檔案和中繼資料。
• 您在檔案中指定的項目類型和切面類型，必須屬於中繼資料工作的範圍。
• 檔案必須上傳至 Cloud Storage bucket。請勿將檔案儲存在名為 CLOUD_STORAGE_URI/deletions/ 的資料夾中。

比較邏輯

Knowledge Catalog 會比較您在中繼資料匯入檔案中提供的值和時間戳記，與專案中現有的值和時間戳記，判斷要修改哪些項目和切面。

概括來說，如果中繼資料匯入檔案中至少有一項建議變更，會在工作執行時變更專案狀態，Knowledge Catalog 就會更新專案中的值，不會引入過時資料。建議的變更必須在中繼資料匯入檔案的更新遮罩欄位或切面鍵欄位中參照。

比對邏輯會因執行的中繼資料匯入工作類型而異。

完整項目同步工作

在完整項目同步中繼資料工作中，Knowledge Catalog 會對工作範圍內的每個項目執行下列任一操作：

• 建立項目和附加切面。如果中繼資料匯入檔案包含專案中不存在的項目，Knowledge Catalog 會建立該項目和附加的切面。
• 刪除項目和附加切面。如果專案中存在某個項目，但中繼資料匯入檔案不含該項目，Knowledge Catalog 會從專案中刪除該項目及其附加的切面。

• 更新項目和附加切面。如果中繼資料匯入檔案和專案中都有某個項目，Knowledge Catalog 會評估該項目的來源時間戳記，以及與該項目相關聯的切面來源時間戳記，藉此判斷要修改哪些值。接著，Knowledge Catalog 會執行下列一或多項操作：

  • 重新建立項目。如果中繼資料匯入檔案中的項目來源建立時間戳記，比專案中的對應時間戳記新，Knowledge Catalog 會在專案中重新建立項目。
  • 更新項目。如果中繼資料匯入檔案中的項目來源更新時間戳記，比專案中的對應時間戳記新，Knowledge Catalog 就會更新專案中的項目。
  • 建立切面。如果專案中沒有某個 aspect，但中繼資料匯入檔案的 aspect 對應、更新遮罩欄位和 aspect 鍵欄位中包含該 aspect，Knowledge Catalog 就會建立該 aspect。
  • 刪除切面。如果專案中存在某個切面，且該切面包含在中繼資料匯入檔案的更新遮罩欄位和切面鍵欄位中，但未包含在切面對應關係中，Knowledge Catalog 會刪除該切面。

  • 更新切面。如果專案中存在某個切面，且該切面包含在切面對應關係、更新遮罩欄位和中繼資料匯入檔案中的切面鍵欄位，且中繼資料匯入檔案中的切面來源更新時間戳記比專案中的對應時間戳記新，Knowledge Catalog 就會更新該切面。

    如果中繼資料匯入檔案未提供切面來源更新時間戳記，但對應的項目標示為更新，Knowledge Catalog 也會更新切面。

    不過，如果中繼資料匯入檔案中至少有一個切面的時間戳記，早於專案中的對應時間戳記，Knowledge Catalog 就不會更新附加的項目。

僅限面向的工作

在僅限切面的中繼資料工作中，Knowledge Catalog 會針對工作範圍內的每個切面，執行下列其中一項操作：

• 建立切面。如果專案中沒有某個 aspect，但中繼資料匯入檔案的 aspect 對應、更新遮罩欄位和 aspect 鍵欄位中包含該 aspect，Knowledge Catalog 就會建立該 aspect。

• 刪除切面。對於選用切面，如果專案中存在該切面，且該切面包含在中繼資料匯入檔案的更新遮罩欄位和切面鍵欄位中，但未包含在切面對應關係中，Knowledge Catalog 會刪除該切面。

  無法刪除必要切面。

• 更新切面。如果專案中存在某個切面，且該切面包含在切面對應關係、更新遮罩欄位和中繼資料匯入檔案中的切面鍵欄位，且中繼資料匯入檔案中的切面來源更新時間戳記比專案中的對應時間戳記新，Knowledge Catalog 就會更新該切面。

  如果中繼資料匯入檔案未提供切面來源更新時間戳記，Knowledge Catalog 也會更新切面。

  Knowledge Catalog 會根據切面來源更新時間戳記更新切面，無論對應項目的項目來源更新時間戳記為何。

建立中繼資料匯入檔案

匯入中繼資料前，請先為工作建立中繼資料匯入檔案。請按照下列步驟操作：

1. 按照本文前述規範準備中繼資料匯入檔案。
2. 將檔案上傳至 Cloud Storage bucket。

您可以在同一項中繼資料工作中，提供多個中繼資料匯入檔案。如要提供多個檔案，請將檔案儲存在同一個 Cloud Storage bucket。執行工作時，您指定的是 bucket，而非特定檔案。Knowledge Catalog 會從儲存在 bucket 中的所有檔案匯入中繼資料，包括子資料夾中的檔案。

執行中繼資料匯入工作

建立中繼資料匯入檔案後，請執行中繼資料匯入工作。

REST

如要匯入中繼資料，請使用 metadataJobs.create 方法。

使用任何要求資料之前，請先修改下列項目的值：

• PROJECT_NUMBER：您的 Google Cloud 專案編號或專案 ID。
• LOCATION_ID： Google Cloud 位置，例如 us-central1。
• METADATA_JOB_ID：選用。中繼資料工作 ID。

• CLOUD_STORAGE_URI：Cloud Storage bucket 或資料夾的 URI，其中包含中繼資料匯入檔案。如要進一步瞭解檔案規定，請參閱「中繼資料匯入檔案」。

• ENTRY_GROUP：工作範圍內項目群組的相對資源名稱，格式為 projects/PROJECT_ID_OR_NUMBER/locations/LOCATION_ID/entryGroups/ENTRY_GROUP_ID。詳情請參閱「工作範圍」。

• ENTRY_TYPE：工作範圍內項目類型的相對資源名稱，格式為 projects/PROJECT_ID_OR_NUMBER/locations/LOCATION_ID/entryTypes/ENTRY_TYPE_ID。詳情請參閱「工作範圍」。

• ASPECT_TYPE：工作範圍內切面類型的相對資源名稱，格式為 projects/PROJECT_ID_OR_NUMBER/locations/LOCATION_ID/aspectTypes/ASPECT_TYPE_ID。建立完整項目同步工作時為選填，建立僅限切面工作時為必填。 詳情請參閱「工作範圍」。
• ENTRY_SYNC_MODE：項目同步模式，例如 FULL 或 NONE。詳情請參閱同步模式。
• LOG_LEVEL：要擷取的記錄層級，例如 INFO 或 DEBUG。詳情請參閱「查看工作記錄及排解問題」。

HTTP 方法和網址：

POST https://dataplex.googleapis.com/v1/projects/TARGET_PROJECT_NUMBER/locations/LOCATION_ID/metadataJobs?metadataJobId=METADATA_JOB_ID

JSON 要求主體：

{
  "type": "IMPORT",
  "import_spec": {
    "source_storage_uri": "gs://CLOUD_STORAGE_URI/",
    "scope": {
      "entryGroups": [
        "ENTRY_GROUP"
      ],
      "entry_types": [
        "ENTRY_TYPE"
      ],
      "aspect_types": [
        "ASPECT_TYPE"
      ]
    },
    "entry_sync_mode": "ENTRY_SYNC_MODE",
    "aspect_sync_mode": "INCREMENTAL",
    "log_level": "LOG_LEVEL"
  }
}

請展開以下其中一個選項，以傳送要求：

curl (Linux、macOS 或 Cloud Shell)

注意：下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI，或已使用 Cloud Shell 自動登入 gcloud CLI。您可以執行 gcloud auth list，查看目前使用的帳戶。

將要求主體儲存在名為 request.json 的檔案中，然後執行下列指令：

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://dataplex.googleapis.com/v1/projects/TARGET_PROJECT_NUMBER/locations/LOCATION_ID/metadataJobs?metadataJobId=METADATA_JOB_ID"

PowerShell (Windows)

注意：下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI。您可以執行 gcloud auth list，查看目前使用的帳戶。

將要求主體儲存在名為 request.json 的檔案中，然後執行下列指令：

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://dataplex.googleapis.com/v1/projects/TARGET_PROJECT_NUMBER/locations/LOCATION_ID/metadataJobs?metadataJobId=METADATA_JOB_ID" | Select-Object -Expand Content

回應會指出長時間執行的作業。

取得中繼資料工作的詳細資料

如要取得中繼資料工作的相關資訊，例如工作狀態和修改的項目數量，請按照下列步驟操作。如要進一步瞭解如何排解失敗工作的問題，請參閱本文的「查看工作記錄及疑難排解」一節。

C#

C#

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 C# 設定說明操作。詳情請參閱 Knowledge Catalog C# API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

using Google.Cloud.Dataplex.V1;

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for GetMetadataJob</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void GetMetadataJobRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        GetMetadataJobRequest request = new GetMetadataJobRequest
        {
            MetadataJobName = MetadataJobName.FromProjectLocationMetadataJob("[PROJECT]", "[LOCATION]", "[METADATAJOB]"),
        };
        // Make the request
        MetadataJob response = catalogServiceClient.GetMetadataJob(request);
    }
}

Go

Go

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Go 設定說明操作。詳情請參閱 Knowledge Catalog Go API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataplex.NewCatalogClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.GetMetadataJobRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#GetMetadataJobRequest.
	}
	resp, err := c.GetMetadataJob(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

Java

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Java 設定說明操作。詳情請參閱 Knowledge Catalog Java API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.GetMetadataJobRequest;
import com.google.cloud.dataplex.v1.MetadataJob;
import com.google.cloud.dataplex.v1.MetadataJobName;

public class SyncGetMetadataJob {

  public static void main(String[] args) throws Exception {
    syncGetMetadataJob();
  }

  public static void syncGetMetadataJob() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      GetMetadataJobRequest request =
          GetMetadataJobRequest.newBuilder()
              .setName(MetadataJobName.of("[PROJECT]", "[LOCATION]", "[METADATAJOB]").toString())
              .build();
      MetadataJob response = catalogServiceClient.getMetadataJob(request);
    }
  }
}

Node.js

Node.js

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Node.js 設定說明操作。詳情請參閱 Knowledge Catalog Node.js API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The resource name of the metadata job, in the format
 *  `projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`.
 */
// const name = 'abc123'

// Imports the Dataplex library
const {CatalogServiceClient} = require('@google-cloud/dataplex').v1;

// Instantiates a client
const dataplexClient = new CatalogServiceClient();

async function callGetMetadataJob() {
  // Construct request
  const request = {
    name,
  };

  // Run request
  const response = await dataplexClient.getMetadataJob(request);
  console.log(response);
}

callGetMetadataJob();

Python

Python

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Python 設定說明操作。詳情請參閱 Knowledge Catalog Python API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_get_metadata_job():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

    # Initialize request argument(s)
    request = dataplex_v1.GetMetadataJobRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_metadata_job(request=request)

    # Handle the response
    print(response)

小茹

Ruby

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Ruby 設定說明操作。詳情請參閱 Knowledge Catalog Ruby API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

require "google/cloud/dataplex/v1"

##
# Snippet for the get_metadata_job call in the CatalogService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::CatalogService::Client#get_metadata_job.
#
def get_metadata_job
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::GetMetadataJobRequest.new

  # Call the get_metadata_job method.
  result = client.get_metadata_job request

  # The returned object is of type Google::Cloud::Dataplex::V1::MetadataJob.
  p result
end

REST

如要取得中繼資料工作的相關資訊，請使用 metadataJobs.get 方法。

使用任何要求資料之前，請先修改下列項目的值：

• PROJECT_NUMBER：您的 Google Cloud 專案編號或專案 ID。
• LOCATION_ID： Google Cloud 位置，例如 us-central1。
• METADATA_JOB_ID：中繼資料工作 ID。

HTTP 方法和網址：

GET https://dataplex.googleapis.com/v1/projects/TARGET_PROJECT_NUMBER/locations/LOCATION_ID/metadataJobs/METADATA_JOB_ID

請展開以下其中一個選項，以傳送要求：

curl (Linux、macOS 或 Cloud Shell)

注意：下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI，或已使用 Cloud Shell 自動登入 gcloud CLI。您可以執行 gcloud auth list，查看目前使用的帳戶。

執行下列指令：

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://dataplex.googleapis.com/v1/projects/TARGET_PROJECT_NUMBER/locations/LOCATION_ID/metadataJobs/METADATA_JOB_ID"

PowerShell (Windows)

注意：下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI。您可以執行 gcloud auth list，查看目前使用的帳戶。

執行下列指令：

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://dataplex.googleapis.com/v1/projects/TARGET_PROJECT_NUMBER/locations/LOCATION_ID/metadataJobs/METADATA_JOB_ID" | Select-Object -Expand Content

您應該會收到如下的 JSON 回覆：

{
  "name": "projects/123456789012/locations/us-central1/metadataJobs/my-metadata-job",
  "uid": "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d",
  "createTime": "2026-07-17T16:30:15Z",
  "updateTime": "2026-07-17T16:35:15Z",
  "type": "IMPORT",
  "importSpec": {
    "sourceStorageUri": "gs://my-bucket/",
    "scope": {
      "entryGroups": [
        "projects/123456789012/locations/us-central1/entryGroups/my-entry-group"
      ],
      "entryTypes": [
        "projects/123456789012/locations/us-central1/entryTypes/my-entry-type"
      ],
      "aspectTypes": [
        "projects/123456789012/locations/us-central1/aspectTypes/my-aspect-type"
      ]
    },
    "entrySyncMode": "FULL",
    "aspectSyncMode": "INCREMENTAL",
    "logLevel": "INFO"
  },
  "status": {
    "state": "SUCCEEDED"
  },
  "importResult": {
    "deletedEntries": "2",
    "updatedEntries": "5",
    "createdEntries": "10",
    "unchangedEntries": "20",
    "updateTime": "2026-07-17T16:35:15Z"
  }
}

取得中繼資料工作清單

您可以取得最近中繼資料工作的清單。系統會定期刪除已達到終端狀態的舊工作。

C#

C#

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 C# 設定說明操作。詳情請參閱 Knowledge Catalog C# API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

using Google.Api.Gax;
using Google.Api.Gax.ResourceNames;
using Google.Cloud.Dataplex.V1;
using System;

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for ListMetadataJobs</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void ListMetadataJobsRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        ListMetadataJobsRequest request = new ListMetadataJobsRequest
        {
            ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
            Filter = "",
            OrderBy = "",
        };
        // Make the request
        PagedEnumerable<ListMetadataJobsResponse, MetadataJob> response = catalogServiceClient.ListMetadataJobs(request);

        // Iterate over all response items, lazily performing RPCs as required
        foreach (MetadataJob item in response)
        {
            // Do something with each item
            Console.WriteLine(item);
        }

        // Or iterate over pages (of server-defined size), performing one RPC per page
        foreach (ListMetadataJobsResponse page in response.AsRawResponses())
        {
            // Do something with each page of items
            Console.WriteLine("A page of results:");
            foreach (MetadataJob item in page)
            {
                // Do something with each item
                Console.WriteLine(item);
            }
        }

        // Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
        int pageSize = 10;
        Page<MetadataJob> singlePage = response.ReadPage(pageSize);
        // Do something with the page of items
        Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
        foreach (MetadataJob item in singlePage)
        {
            // Do something with each item
            Console.WriteLine(item);
        }
        // Store the pageToken, for when the next page is required.
        string nextPageToken = singlePage.NextPageToken;
    }
}

Go

Go

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Go 設定說明操作。詳情請參閱 Knowledge Catalog Go API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
	"google.golang.org/api/iterator"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataplex.NewCatalogClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.ListMetadataJobsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListMetadataJobsRequest.
	}
	it := c.ListMetadataJobs(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp

		// If you need to access the underlying RPC response,
		// you can do so by casting the `Response` as below.
		// Otherwise, remove this line. Only populated after
		// first call to Next(). Not safe for concurrent access.
		_ = it.Response.(*dataplexpb.ListMetadataJobsResponse)
	}
}

Java

Java

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Java 設定說明操作。詳情請參閱 Knowledge Catalog Java API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.ListMetadataJobsRequest;
import com.google.cloud.dataplex.v1.LocationName;
import com.google.cloud.dataplex.v1.MetadataJob;

public class SyncListMetadataJobs {

  public static void main(String[] args) throws Exception {
    syncListMetadataJobs();
  }

  public static void syncListMetadataJobs() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      ListMetadataJobsRequest request =
          ListMetadataJobsRequest.newBuilder()
              .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
              .setPageSize(883849137)
              .setPageToken("pageToken873572522")
              .setFilter("filter-1274492040")
              .setOrderBy("orderBy-1207110587")
              .build();
      for (MetadataJob element : catalogServiceClient.listMetadataJobs(request).iterateAll()) {
        // doThingsWith(element);
      }
    }
  }
}

Node.js

Node.js

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Node.js 設定說明操作。詳情請參閱 Knowledge Catalog Node.js API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The resource name of the parent location, in the format
 *  `projects/{project_id_or_number}/locations/{location_id}`
 */
// const parent = 'abc123'
/**
 *  Optional. The maximum number of metadata jobs to return. The service might
 *  return fewer jobs than this value. If unspecified, at most 10 jobs are
 *  returned. The maximum value is 1,000.
 */
// const pageSize = 1234
/**
 *  Optional. The page token received from a previous `ListMetadataJobs` call.
 *  Provide this token to retrieve the subsequent page of results. When
 *  paginating, all other parameters that are provided to the
 *  `ListMetadataJobs` request must match the call that provided the page
 *  token.
 */
// const pageToken = 'abc123'
/**
 *  Optional. Filter request. Filters are case-sensitive.
 *  The service supports the following formats:
 *  * `labels.key1 = "value1"`
 *  * `labels:key1`
 *  * `name = "value"`
 *  You can combine filters with `AND`, `OR`, and `NOT` operators.
 */
// const filter = 'abc123'
/**
 *  Optional. The field to sort the results by, either `name` or `create_time`.
 *  If not specified, the ordering is undefined.
 */
// const orderBy = 'abc123'

// Imports the Dataplex library
const {CatalogServiceClient} = require('@google-cloud/dataplex').v1;

// Instantiates a client
const dataplexClient = new CatalogServiceClient();

async function callListMetadataJobs() {
  // Construct request
  const request = {
    parent,
  };

  // Run request
  const iterable = dataplexClient.listMetadataJobsAsync(request);
  for await (const response of iterable) {
      console.log(response);
  }
}

callListMetadataJobs();

Python

Python

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Python 設定說明操作。詳情請參閱 Knowledge Catalog Python API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_list_metadata_jobs():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

    # Initialize request argument(s)
    request = dataplex_v1.ListMetadataJobsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_metadata_jobs(request=request)

    # Handle the response
    for response in page_result:
        print(response)

小茹

Ruby

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Ruby 設定說明操作。詳情請參閱 Knowledge Catalog Ruby API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

require "google/cloud/dataplex/v1"

##
# Snippet for the list_metadata_jobs call in the CatalogService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::CatalogService::Client#list_metadata_jobs.
#
def list_metadata_jobs
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::ListMetadataJobsRequest.new

  # Call the list_metadata_jobs method.
  result = client.list_metadata_jobs request

  # The returned object is of type Gapic::PagedEnumerable. You can iterate
  # over elements, and API calls will be issued to fetch pages as needed.
  result.each do |item|
    # Each element is of type ::Google::Cloud::Dataplex::V1::MetadataJob.
    p item
  end
end

REST

如要取得最近的中繼資料工作清單，請使用 metadataJobs.list 方法。

取消中繼資料工作

您可以取消不想執行的中繼資料工作。

注意： 如果取消進行中的中繼資料匯入工作，系統可能會部分套用工作中的變更。建議您執行其他中繼資料工作，還原已取消工作所做的變更，藉此重設專案中項目群組的狀態。

C#

C#

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 C# 設定說明操作。詳情請參閱 Knowledge Catalog C# API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

using Google.Cloud.Dataplex.V1;

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for CancelMetadataJob</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void CancelMetadataJobRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        CancelMetadataJobRequest request = new CancelMetadataJobRequest
        {
            MetadataJobName = MetadataJobName.FromProjectLocationMetadataJob("[PROJECT]", "[LOCATION]", "[METADATAJOB]"),
        };
        // Make the request
        catalogServiceClient.CancelMetadataJob(request);
    }
}

Go

Go

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Go 設定說明操作。詳情請參閱 Knowledge Catalog Go API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataplex.NewCatalogClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.CancelMetadataJobRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CancelMetadataJobRequest.
	}
	err = c.CancelMetadataJob(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

Java

Java

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Java 設定說明操作。詳情請參閱 Knowledge Catalog Java API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

import com.google.cloud.dataplex.v1.CancelMetadataJobRequest;
import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.MetadataJobName;
import com.google.protobuf.Empty;

public class SyncCancelMetadataJob {

  public static void main(String[] args) throws Exception {
    syncCancelMetadataJob();
  }

  public static void syncCancelMetadataJob() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      CancelMetadataJobRequest request =
          CancelMetadataJobRequest.newBuilder()
              .setName(MetadataJobName.of("[PROJECT]", "[LOCATION]", "[METADATAJOB]").toString())
              .build();
      catalogServiceClient.cancelMetadataJob(request);
    }
  }
}

Node.js

Node.js

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Node.js 設定說明操作。詳情請參閱 Knowledge Catalog Node.js API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The resource name of the job, in the format
 *  `projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`
 */
// const name = 'abc123'

// Imports the Dataplex library
const {CatalogServiceClient} = require('@google-cloud/dataplex').v1;

// Instantiates a client
const dataplexClient = new CatalogServiceClient();

async function callCancelMetadataJob() {
  // Construct request
  const request = {
    name,
  };

  // Run request
  const response = await dataplexClient.cancelMetadataJob(request);
  console.log(response);
}

callCancelMetadataJob();

Python

Python

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Python 設定說明操作。詳情請參閱 Knowledge Catalog Python API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_cancel_metadata_job():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

    # Initialize request argument(s)
    request = dataplex_v1.CancelMetadataJobRequest(
        name="name_value",
    )

    # Make the request
    client.cancel_metadata_job(request=request)

小茹

Ruby

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Ruby 設定說明操作。詳情請參閱 Knowledge Catalog Ruby API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

require "google/cloud/dataplex/v1"

##
# Snippet for the cancel_metadata_job call in the CatalogService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::CatalogService::Client#cancel_metadata_job.
#
def cancel_metadata_job
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::CancelMetadataJobRequest.new

  # Call the cancel_metadata_job method.
  result = client.cancel_metadata_job request

  # The returned object is of type Google::Protobuf::Empty.
  p result
end

REST

如要取消中繼資料工作，請使用 metadataJobs.cancel 方法。

查看工作記錄檔並排解問題

使用 Cloud Logging 查看中繼資料工作的記錄。詳情請參閱「監控 Knowledge Catalog 記錄」。

建立中繼資料工作時，您需要設定記錄層級。可用的記錄層級如下：

• INFO：提供整體工作層級的記錄。包含匯入項目的匯總記錄，但不會指定哪個匯入項目發生錯誤。

• DEBUG：提供每個匯入項目的詳細記錄。使用偵錯層級記錄，排解特定匯入項目的問題。舉例來說，您可以使用偵錯層級記錄，找出工作範圍內缺少的資源、不符合相關聯項目類型或切面類型的項目或切面，或其他中繼資料匯入檔案設定錯誤。

  注意： 視中繼資料工作的大小和產生的記錄數量而定，偵錯層級記錄可能會產生額外費用。詳情請參閱「Google Cloud Observability 定價」一文。

驗證錯誤

Knowledge Catalog 會根據專案中的現有中繼資料，驗證中繼資料匯入檔案。如果發生驗證問題，工作狀態可能會傳回下列其中一種狀態：

• FAILED：中繼資料匯入檔案發生錯誤時，就會出現這個錯誤。Knowledge Catalog 不會匯入任何中繼資料，且工作會失敗。中繼資料匯入檔案中的錯誤示例包括：
  • 檔案中的項目無法剖析為有效的匯入項目
  • 檔案中的項目或切面屬於不屬於工作範圍的項目群組、項目類型或切面類型
  • 工作中指定了多個相同的項目名稱
  • 切面圖或切面索引鍵中指定的切面類型未使用 PROJECT_ID_OR_NUMBER.LOCATION_ID.ASPECT_TYPE_ID@OPTIONAL_PATH 格式
  • 必要面向標示為待刪除
• SUCCEEDED_WITH_ERRORS：中繼資料匯入檔案可成功剖析，但匯入檔案中的項目會導致專案中的項目處於不一致狀態時，就會發生這種情況。Knowledge Catalog 會忽略這類項目，但會從檔案匯入其餘中繼資料。

使用工作記錄排解錯誤。

後續步驟

• 在 Knowledge Catalog 搜尋資料資產
• 管理切面並充實中繼資料
• 管理項目及擷取自訂來源
• 匯出中繼資料