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。如需将作业状态更新为 DELETED，您需要具备 storagetransfer.jobs.delete 权限。
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。