Method: transferJobs.patch

Met à jour une tâche de transfert. La mise à jour des spécifications de transfert d'une tâche n'affecte pas les opérations de transfert déjà en cours d'exécution.

Remarque:Le champ status de la tâche peut être modifié à l'aide de cette RPC (par exemple, pour définir l'état d'une tâche sur DELETED, DISABLED ou ENABLED).

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
jobName

string

Obligatoire. Nom de la tâche à mettre à jour.

L'autorisation IAM suivante est requise pour la ressource jobName indiquée :

  • storagetransfer.jobs.update

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "projectId": string,
  "transferJob": {
    object (TransferJob)
  },
  "updateTransferJobFieldMask": string
}
Champs
projectId

string

Obligatoire. ID du projet Google Cloud propriétaire de la tâche.
transferJob

object (TransferJob)

Obligatoire. Tâche à mettre à jour. transferJob doit spécifier un ou plusieurs des cinq champs suivants: description, transferSpec, notificationConfig, loggingConfig et status. Un UpdateTransferJobRequest qui spécifie d'autres champs est refusé avec l'erreur INVALID_ARGUMENT. L'autorisation storagetransfer.jobs.delete est requise pour définir l'état d'une tâche sur DELETED.
updateTransferJobFieldMask

string (FieldMask format)

Masque de champ des champs de transferJob à mettre à jour dans cette requête. Les champs description, transferSpec, notificationConfig, loggingConfig et status peuvent être mis à jour dans transferJob. Pour mettre à jour le transferSpec de la tâche, vous devez fournir une spécification de transfert complète. Une spécification incomplète dans laquelle des champs obligatoires sont manquants est rejetée avec l'erreur INVALID_ARGUMENT.

Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo"

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de TransferJob.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez Authentication Overview.