Method: transferJobs.patch

Aggiorna un job di trasferimento. L'aggiornamento delle specifiche di trasferimento di un job non influisce sulle operazioni di trasferimento già in esecuzione.

Nota:il campo status del job può essere modificato utilizzando questa chiamata RPC (ad esempio, per impostare lo stato di un job su DELETED, DISABLED o ENABLED).

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
jobName

string

Obbligatorio. Il nome del job da aggiornare.

L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata jobName:

  • storagetransfer.jobs.update

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "projectId": string,
  "transferJob": {
    object (TransferJob)
  },
  "updateTransferJobFieldMask": string
}
Campi
projectId

string

Obbligatorio. L'ID del progetto Google Cloud proprietario del job.
transferJob

object (TransferJob)

Obbligatorio. Il job da aggiornare. Per transferJob è previsto che vengano specificati uno o più dei cinque campi: description, transferSpec, notificationConfig, loggingConfig e status. Un UpdateTransferJobRequest che specifica altri campi viene rifiutato con l'errore INVALID_ARGUMENT. L'aggiornamento dello stato di un job su DELETED richiede l'autorizzazione storagetransfer.jobs.delete.
updateTransferJobFieldMask

string (FieldMask format)

La maschera dei campi in transferJob da aggiornare in questa richiesta. I campi in transferJob che possono essere aggiornati sono: description, transferSpec, notificationConfig, loggingConfig e status. Per aggiornare il transferSpec del job, è necessario fornire una specifica di trasferimento completa. Una specifica incompleta con campi obbligatori mancanti viene rifiutata con l'errore INVALID_ARGUMENT.

Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: "user.displayName,photo".

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di TransferJob.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la sezione Authentication Overview.