REST Resource: projects.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,

  // 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 un nom de ressource se terminant par operations/{uniqueId}.
metadata

object

{

createTime : heure de création de l'opération.

endTime : heure à laquelle l'exécution de l'opération s'est terminée.

target : chemin d'accès à la ressource défini par le serveur pour la cible de l'opération.

verb : nom du verbe exécuté par l'opération.

statusDetail : statut lisible de l'opération, le cas échéant.

cancelRequested : indique si l'utilisateur a demandé l'annulation de l'opération. Les opérations qui ont bien été annulées possèdent la valeur Operation.error avec un code d'état google.rpc.Status.code de 1, correspondant au code Code.CANCELLED.

apiVersion : version de l'API utilisée pour démarrer l'opération.

}
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.
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

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.

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.