Method: transferJobs.patch

Aktualisiert einen Übertragungsjob. Das Aktualisieren der Übertragungsspezifikation eines Jobs wirkt sich nicht auf bereits laufende Übertragungsvorgänge aus.

Hinweis:Das Feld status des Jobs kann mit diesem RPC geändert werden, z. B. um den Status eines Jobs auf DELETED, DISABLED oder ENABLED festzulegen.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
jobName

string

Pflichtangabe. Der Name des Jobs, der aktualisiert werden soll.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource jobName erforderlich:

  • storagetransfer.jobs.update

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "projectId": string,
  "transferJob": {
    object (TransferJob)
  },
  "updateTransferJobFieldMask": string
}
Felder
projectId

string

Pflichtangabe. Die ID des Google Cloud-Projekts, zu dem der Job gehört.
transferJob

object (TransferJob)

Pflichtangabe. Der zu aktualisierende Job. Für transferJob müssen mindestens eines der fünf Felder angegeben werden: description, transferSpec, notificationConfig, loggingConfig und status. Ein UpdateTransferJobRequest, in dem andere Felder angegeben sind, wird mit dem Fehler INVALID_ARGUMENT abgelehnt. Zum Aktualisieren des Jobstatus auf DELETED ist die Berechtigung storagetransfer.jobs.delete erforderlich.
updateTransferJobFieldMask

string (FieldMask format)

Die Feldmaske der Felder in transferJob, die in dieser Anfrage aktualisiert werden sollen. Die folgenden Felder in transferJob können aktualisiert werden: description, transferSpec, notificationConfig, loggingConfig und status. Um die transferSpec des Jobs zu aktualisieren, muss eine vollständige Übertragungsspezifikation angegeben werden. Eine unvollständige Spezifikation, in der Pflichtfelder fehlen, wird mit dem Fehler INVALID_ARGUMENT abgelehnt.

Dies ist eine durch Kommas getrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von TransferJob.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie unter Authentication Overview.