Method: transferJobs.patch

転送ジョブを更新します。ジョブの転送仕様を更新しても、すでに実行中の転送オペレーションには影響しません。

注: この RPC を使用して、ジョブの status フィールドを変更できます（ジョブのステータスを DELETED、DISABLED、ENABLED に設定する場合など）。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 の 5 つのフィールドのいずれか 1 つ以上を指定する必要があります。他のフィールドを指定する 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 をご覧ください。