Method: transferJobs.patch

更新轉移工作。更新工作移轉規格不會影響到目前執行中的移轉作業。

注意：您可以使用這個 RPC 修改工作 status 欄位 (例如將工作狀態設為 DELETED、DISABLED 或 ENABLED)。

HTTP 要求

PATCH https://storagetransfer.googleapis.com/v1/{jobName=transferJobs/**}

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
jobName

string

這是必要旗標，要更新的工作名稱。

授權需要指定資源 jobName 的下列 IAM 權限：

  • storagetransfer.jobs.update

要求主體

要求主體包含下列結構的資料：

JSON 表示法 
{
  "projectId": string,
  "transferJob": {
    object (TransferJob)
  },
  "updateTransferJobFieldMask": string
}
欄位
projectId

string

這是必要旗標，擁有工作項目的 Google Cloud 專案 ID。
transferJob

object (TransferJob)

這是必要旗標，要更新的工作。transferJob 應指定一或多個欄位：description、transferSpec、notificationConfig、loggingConfig 和 status。指定其他欄位的 UpdateTransferJobRequest 會遭到拒絕，並顯示錯誤 INVALID_ARGUMENT。您必須具備 storagetransfer.jobs.delete 權限，才能將工作狀態更新為 DELETED。
updateTransferJobFieldMask

string (FieldMask format)

在本要求中要更新的 transferJob 欄位的欄位遮罩。transferJob 中可更新的欄位包括：description、transferSpec、notificationConfig、loggingConfig 和 status。如要更新工作 transferSpec，您必須提供完整的轉移規格。如果規格不完整，缺少任何必填欄位，系統會拒絕，並傳回 INVALID_ARGUMENT 錯誤。

這是以半形逗號分隔的完整欄位名稱清單。範例："user.displayName,photo"。

回應主體

如果成功，回應主體會包含 TransferJob 的執行個體。

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/cloud-platform

詳情請參閱 Authentication Overview。