Package google.longrunning
Opération
Cette ressource représente une opération de longue durée résultant d'un appel d'API réseau.
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 |
Any
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.
|
done |
bool
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 est égal à true , un seul élément 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 |
Status
Résultat d'erreur de l'opération en cas d'échec ou d'annulation.
|
response |
Any
Réponse normale et réussie 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 .
|
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2023/12/01 (UTC).
[null,null,["Dernière mise à jour le 2023/12/01 (UTC)."],[[["The `Operation` resource represents a long-running operation initiated by a network API call."],["Each operation has a unique name, metadata (often with progress information), and a status indicating if it's done."],["Upon completion (`done` is `true`), an operation provides either an `error` or a `response` indicating the outcome."],["The `response` field contains the operation's result, which varies depending on the original API method called."]]],["A long-running network API call is represented by an \"Operation\" resource. This resource includes a unique `name`, service-specific `metadata` about progress, and a `done` status flag. Upon completion (`done` is true), the `result` field will contain either an `error` status or a successful `response`. If the operation is in progress (`done` is false) `result` will not be set. The `response` contains data if it was a successful operation.\n"]]