Cette page a été traduite par l'API Cloud Translation.

Package google.longrunning

Index

Operations (interface)
CancelOperationRequest (message)
GetOperationRequest (message)
ListOperationsRequest (message)
ListOperationsResponse (message)
Operation (message)

Opérations

Gère les opérations de longue durée effectuées avec un service API.

Lorsqu'une méthode API prend normalement beaucoup de temps pour aboutir, elle peut être conçue pour renvoyer l'interface Operation au client. Le client peut se servir de cette interface pour recevoir la réponse réelle de manière asynchrone en interrogeant la ressource de l'opération, ou en transmettant la ressource de l'opération à une autre API (telle que l'API Pub/Sub). Tout service d'API qui renvoie des opérations de longue durée doit implémenter l'interface Operations afin que les développeurs puissent bénéficier d'une expérience client cohérente.

CancelOperation

CancelOperation
`rpc CancelOperation(CancelOperationRequest) returns (Empty)` 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. Attention:Si vous annulez une tâche de transfert, vos données peuvent se retrouver dans un état inconnu. Nous vous recommandons de restaurer l'état à la fois à la destination et à la source une fois la requête `cancel` terminée afin que vos données soient dans un état cohérent. 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. 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.

rpc CancelOperation(CancelOperationRequest) returns (Empty)

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.

Attention:Si vous annulez une tâche de transfert, vos données peuvent se retrouver dans un état inconnu. Nous vous recommandons de restaurer l'état à la fois à la destination et à la source une fois la requête cancel terminée afin que vos données soient dans un état cohérent.

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.

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.

GetOperation

GetOperation
`rpc GetOperation(GetOperationRequest) returns (Operation)` Récupère le dernier état d'une opération de longue durée. Cette méthode permet aux clients d'interroger le résultat de l'opération à des intervalles recommandés par le service d'API. 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.

rpc GetOperation(GetOperationRequest) returns (Operation)

Récupère le dernier état d'une opération de longue durée. Cette méthode permet aux clients d'interroger le résultat de l'opération à des intervalles recommandés par le service d'API.

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.

ListOperations

ListOperations
`rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)` Répertorie les opérations de transfert. Les opérations sont triées par date de création, dans l'ordre chronologique inverse. 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.

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

Répertorie les opérations de transfert. Les opérations sont triées par date de création, dans l'ordre chronologique inverse.

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.

CancelOperationRequest

Message de requête pour Operations.CancelOperation.

Champs

Champs
`name`	`string` Nom de la ressource de l'opération à annuler.

name

string

Nom de la ressource de l'opération à annuler.

GetOperationRequest

Message de requête pour Operations.GetOperation.

Champs

Champs
`name`	`string` Nom de ressource de l'opération.

name

string

Nom de ressource de l'opération.

ListOperationsRequest

Message de requête pour Operations.ListOperations.

Champs
`name`	`string` Obligatoire. Nom du type listé. Doit être `transferOperations`.
`filter`	`string` Obligatoire. Liste de paramètres de requête spécifiés sous forme de texte JSON au format: `{"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobNamePattern": "job_name_pattern", "operationNames":["opid1","opid2",...], "operationNamePattern": "operation_name_pattern", "minCreationTime": "min_creation_time", "maxCreationTime": "max_creation_time", "transferStatuses":["status1","status2",...]}` Étant donné que `jobNames`, `operationNames` et `transferStatuses` acceptent plusieurs valeurs, ils doivent être spécifiés à l'aide de l'notation de tableau. `projectId` est le seul argument obligatoire. Si vous spécifiez `jobNamePattern` et `operationNamePattern`, ils doivent correspondre respectivement au nom complet de la tâche ou de l'opération. "*" est un caractère générique correspondant à zéro ou plusieurs caractères. `minCreationTime` et `maxCreationTime` doivent être des codes temporels encodés sous forme de chaîne au format RFC 3339. Les valeurs valides pour `transferStatuses` sont insensibles à la casse: `IN_PROGRESS`, `PAUSED`, `SUCCESS`, `FAILED` et `ABORTED`.
`page_size`	`int32` Taille de la page de la liste. La valeur maximale autorisée est de 256.
`page_token`	`string` Le jeton de page de la liste.

ListOperationsResponse

Le message de réponse pour Operations.ListOperations.

Champs

Champs
`operations[]`	`Operation` La liste des opérations qui correspondent au filtre spécifié dans la requête.
`next_page_token`	`string` Le jeton de page suivante de la liste standard.

operations[]

Operation

La liste des opérations qui correspondent au filtre spécifié dans la requête.

next_page_token

string

Le jeton de page suivante de la liste standard.

Operation

Cette ressource représente une opération de longue durée résultant d'un appel d'API réseau.

Champs
`name`	`string` Nom unique attribué par le serveur. Le format de `name` est `transferOperations/some/unique/name`.
`metadata`	`Any` Représente l'objet de l'opération de transfert. Pour demander un objet `TransferOperation`, utilisez `transferOperations.get`.
`done`	`bool` Si la valeur est `false`, cela signifie que l'opération est toujours en cours. Si elle est définie sur `true`, l'opération est terminée, et un message `error` ou `response` est disponible.
Champ d'union `result`. Résultat de l'opération, qui peut être une erreur (message `error`) ou une réponse valide (message `response`). Si `done` == `false`, ni `error`, ni `response` ne sont définis. Si `done` == `true`, une seule des options `error` ou `response` peut être définie. Certains services peuvent ne pas fournir le résultat. `result` ne peut être qu'un des éléments suivants :
`error`	`Status` Résultat d'erreur de l'opération en cas d'échec ou d'annulation.
`response`	`Any` Réponse normale de réussite de l'opération. Si la méthode d'origine ne renvoie aucune donnée en cas de réussite (telle que `Delete`), la réponse est `google.protobuf.Empty`. Si la méthode d'origine est une méthode `Get`/`Create`/`Update` standard, la réponse doit correspondre à la ressource. Pour les autres méthodes, la réponse doit avoir le type `XxxResponse`, où `Xxx` est le nom de la méthode d'origine. Par exemple, si le nom de la méthode d'origine est `TakeSnapshot()`, le type de réponse déduit est `TakeSnapshotResponse`.