Method: transferOperations.cancel

Annule un transfert. Utilisez la méthode transferOperations.get pour vérifier si l'annulation a réussi ou si l'opération a abouti malgré la requête cancel.

Lorsque vous annulez une opération, le transfert en cours est interrompu. Pour les tâches de transfert récurrentes, la prochaine instance de la tâche de transfert s'exécutera toujours. Par exemple, si votre tâche est configurée pour s'exécuter tous les jours à 13h00 et que vous annulez l'opération du lundi à 13h05, le transfert du lundi s'arrêtera. Toutefois, une tâche de transfert sera toujours tentée mardi.

Cela ne s'applique qu'aux opérations en cours d'exécution. Si aucune opération n'est en cours d'exécution, cancel ne fait rien.

Lorsque vous annulez une tâche, la tâche suivante calcule un delta de fichiers et peut réparer tout état incohérent. Par exemple, si vous exécutez une tâche tous les jours et que celle d'aujourd'hui a détecté 10 nouveaux fichiers et transféré cinq fichiers avant que vous ne l'annuliez, l'opération de transfert de demain calculera un nouveau delta avec les cinq fichiers qui n'ont pas été copiés aujourd'hui, ainsi que les nouveaux fichiers découverts demain.

Requête HTTP

POST https://storagetransfer.googleapis.com/v1/{name=transferOperations/**}:cancel

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Le nom de la ressource de l'opération à annuler.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse est un objet JSON vide.

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.