REST Resource: organizations.locations.operations

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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of mutually exclusive fields.
}
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 un nom de ressource se terminant par operations/{unique_id}.
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. Un 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 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.
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, seul error ou response peut être défini. Certains services peuvent ne pas fournir le résultat. Voici une liste de champs mutuellement exclusifs. Au maximum, un seul de ces champs sera défini dans une réponse :
error

object (Status)

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

object

Réponse normale indiquant la 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.

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

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.