Ressource : Operation
Cette ressource représente une opération de longue durée résultant d'un appel d'API réseau.
Représentation JSON |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
Champs | |
---|---|
name |
Nom attribué par le serveur. Unique au sein du service qui le renvoie initialement. Si vous utilisez le mappage HTTP par défaut, le champ |
metadata |
Métadonnées spécifiques au service associées à l'opération. Ce champ contient généralement des informations de progression et des métadonnées courantes telles que la date de création. Certains services peuvent ne pas fournir ce genre de métadonnées. Toute méthode renvoyant une opération de longue durée doit indiquer le type de métadonnées, le cas échéant. Objet contenant des champs d'un type arbitraire. Un champ supplémentaire |
done |
Si la valeur est |
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 , un seul des éléments error ou response peut être défini. Certains services peuvent ne pas fournir le résultat. result ne peut être qu'un des éléments suivants : |
|
error |
Résultat d'erreur de l'opération en cas d'échec ou d'annulation. |
response |
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 Objet contenant des champs d'un type arbitraire. Un champ supplémentaire |
Méthodes |
|
---|---|
|
Démarre l'annulation asynchrone sur une opération de longue durée. |
|
Supprime une opération de longue durée. |
|
Récupère le dernier état d'une opération de longue durée. |
|
Répertorie les opérations qui correspondent au filtre spécifié dans la requête. |