Ressource REST : operations

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

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 result can be only one of the following:
  "error": {
    object(Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}
Champs
name

string

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 name doit être au format operations/some/unique/name.

metadata

object

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. Le champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

done

boolean

Si la valeur est définie sur 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.

Valeur result du champ d'union. Le résultat de l'opération, qui peut être un message error ou response valide. Si done correspond à false, aucun message error ni response n'est défini. Si done correspond à true, exactement un message error ou response est défini. Le champ result ne peut être que l'un des éléments suivants :
error

object(Status)

Résultat d'erreur de l'opération en cas d'échec ou d'annulation.

response

object

Réponse normale de l'opération lorsqu'elle aboutit. 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 un message standard Get/Create/Update, la réponse doit être la ressource. Pour les autres méthodes, la réponse doit comporter le type XxxResponse, où Xxx correspond au nom de la méthode d'origine. Par exemple, si le nom de la méthode d'origine est TakeSnapshot(), le type de la réponse supposée est TakeSnapshotResponse.

Objet contenant des champs d'un type arbitraire. Le champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

Méthodes

cancel

Démarre l'annulation asynchrone sur une opération de longue durée.

delete

Supprime une opération de longue durée.

get

Récupère le dernier état d'une opération de longue durée.

list

Répertorie les opérations qui correspondent au filtre spécifié dans la requête.