Indice
-
Operations
(interface) -
CancelOperationRequest
(message) -
DeleteOperationRequest
(message) -
GetOperationRequest
(message) -
ListOperationsRequest
(message) -
ListOperationsResponse
(message) -
Operation
(message) -
WaitOperationRequest
(message)
Opérations
Gère les opérations de longue durée avec un service API.
Lorsqu'une méthode API prend normalement beaucoup de temps, elle peut être conçue pour renvoyer Operation
au client, et le client peut utiliser cette interface pour recevoir la réponse réelle de manière asynchrone en interrogeant la ressource d'opération, ou transmettre la ressource d'opération à une autre API ( comme l'API Pub/Sub) pour recevoir la réponse. Tout service 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.
AnnulerOpération |
---|
Démarre l’annulation asynchrone sur une opération de longue durée. Le serveur fait de son mieux pour annuler l'opération, mais le succès n'est pas garanti. Si le serveur ne prend pas en charge cette méthode, il renvoie
|
Opération Supprimer |
---|
Supprime une opération de longue durée. Cette méthode indique que le client n'est plus intéressé par le résultat de l'opération. Cela n'annule pas l'opération. Si le serveur ne prend pas en charge cette méthode, il renvoie
|
ObtenirOpération |
---|
Obtient le dernier état d’une opération de longue durée. Les clients peuvent utiliser cette méthode pour interroger le résultat de l'opération à intervalles recommandés par le service API.
|
ListeOpérations |
---|
Répertorie les opérations qui correspondent au filtre spécifié dans la demande. Si le serveur ne prend pas en charge cette méthode, il renvoie
|
AttendreOpération |
---|
Attend que l'opération de longue durée spécifiée soit terminée ou atteigne au plus un délai d'attente spécifié, renvoyant le dernier état. Si l'opération est déjà effectuée, le dernier état est immédiatement renvoyé. Si le délai d'expiration spécifié est supérieur au délai d'expiration HTTP/RPC par défaut, le délai d'expiration HTTP/RPC est utilisé. Si le serveur ne prend pas en charge cette méthode, il renvoie
|
AnnulerOperationRequest
Le message de demande pour Operations.CancelOperation
.
Des champs | |
---|---|
name | Nom de la ressource d'opération à annuler. |
SupprimerOperationRequest
Le message de demande pour Operations.DeleteOperation
.
Des champs | |
---|---|
name | Nom de la ressource d'opération à supprimer. |
GetOperationRequest
Le message de demande pour Operations.GetOperation
.
Des champs | |
---|---|
name | Le nom de la ressource d’opération. |
ListOperationsRequest
Le message de demande pour Operations.ListOperations
.
Des champs | |
---|---|
name | Le nom de la ressource parent de l'opération. |
filter | Le filtre de liste standard. |
page_size | Taille de page de liste standard. |
page_token | Le jeton de page de liste standard. |
ListeOpérationsRéponse
Le message de réponse pour Operations.ListOperations
.
Des champs | |
---|---|
operations[] | Liste des opérations qui correspondent au filtre spécifié dans la demande. |
next_page_token | Le jeton standard de la page suivante de la liste. |
Opération
Cette ressource représente une opération de longue durée qui est le résultat d'un appel d'API réseau.
Des champs | |
---|---|
name | Le nom attribué par le serveur, qui est unique uniquement au sein du même service qui l'a renvoyé à l'origine. Si vous utilisez le mappage HTTP par défaut, le |
metadata | Métadonnées spécifiques au service associées à l'opération. Il contient généralement des informations sur la progression et des métadonnées communes telles que l'heure de création. Certains services peuvent ne pas fournir de telles métadonnées. Toute méthode qui renvoie une opération de longue durée doit documenter le type de métadonnées, le cas échéant. |
done | Si la valeur est |
result du champ Union. Le résultat de l'opération, qui peut être soit une error , soit une response valide. Si done == false , ni error ni response ne sont définies. Si done == true , exactement une error ou response peut être définie. Certains services peuvent ne pas fournir le résultat. result ne peut être que l'un des éléments suivants : | |
error | Le résultat de l'erreur de l'opération en cas d'échec ou d'annulation. |
response | La réponse normale et réussie de l’opération. Si la méthode d'origine ne renvoie aucune donnée en cas de succès, telle que |
WaitOperationRequest
Le message de demande pour Operations.WaitOperation
.
Des champs | |
---|---|
name | Nom de la ressource d’opération à attendre. |
timeout | La durée maximale d'attente avant l'expiration. Si ce champ est laissé vide, l'attente sera au maximum égale à la durée autorisée par le protocole HTTP/RPC sous-jacent. Si la date limite du contexte RPC est également spécifiée, la plus courte sera utilisée. |