Este recurso representa una operación de larga duración que es el resultado de una llamada a la API de la red.
Representación JSON | |
---|---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
Campos | ||
---|---|---|
name |
El nombre asignado por el servidor, que solo es único dentro del mismo servicio que lo muestra en un principio. Si usas la asignación HTTP predeterminada, el |
|
metadata |
Metadatos específicos del servicio asociados con la operación. Por lo general, contiene información de progreso y metadatos comunes, como la fecha de creación. Puede que algunos servicios no proporcionen estos metadatos. Cualquier método que muestra una operación de larga duración debe documentar el tipo de metadatos, si corresponde. Un objeto que contiene campos de un tipo arbitrario. Un campo adicional |
|
done |
Si el valor es |
|
Campo de unión result . El resultado de la operación, que puede ser un error o una response válida. Si done == false , no se establecen error ni response . Si done == true , se establece error o response . result puede ser uno de los siguientes: |
||
error |
El resultado de error de la operación en caso de falla o cancelación. |
|
response |
La respuesta normal de la operación en caso de éxito. Si el método original no muestra datos en caso de éxito, como Un objeto que contiene campos de un tipo arbitrario. Un campo adicional |
Estado
El tipo de Status
define un modelo de error lógico que es adecuado para entornos de programación diferentes, incluidas las API de REST y las API de RPC. Lo usa gRPC. Cada mensaje Status
contiene tres datos: código de error, mensaje de error y detalles del error.
Puedes obtener más información sobre este modelo de error y cómo trabajar con él en la guía de diseño de API.
Representación JSON | |
---|---|
{ "code": number, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Campos | |
---|---|
code |
El código de estado, que debe ser un valor enum de |
message |
Un mensaje de error dirigido al desarrollador, que debe estar en inglés. Cualquier mensaje de error dirigido al usuario debe localizarse y enviarse al campo |
details[] |
Una lista de mensajes que contienen los detalles del error. Hay un conjunto común de tipos de mensajes para que usen las API. Un objeto que contiene campos de un tipo arbitrario. Un campo adicional |