Operation
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
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 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.
} |
| Campos |
name |
string
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 name debe ser un nombre de recurso que termine con operations/{unique_id}.
|
metadata |
object
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 "@type" contiene una URI que identifica el tipo. Ejemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.
|
done |
boolean
Si el valor es false, significa que la operación aún está en progreso. Si es true, la operación está completa, y error o response están disponibles.
|
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 puede establecer exactamente uno de los valores error o response. Es posible que algunos servicios no proporcionen el resultado. result puede ser uno de los siguientes: |
error |
object (Status)
El resultado de error de la operación en caso de falla o cancelación.
|
response |
object
La respuesta normal y correcta de la operación. Si el método original no muestra datos en caso de éxito, como Delete, la respuesta es google.protobuf.Empty. Si el método original es Get, Create o Update estándar, la respuesta debe ser el recurso. Para otros métodos, la respuesta debe tener el tipo XxxResponse, en la que Xxx es el nombre del método original. Por ejemplo, si el nombre del método original es TakeSnapshot(), el tipo de respuesta inferido es TakeSnapshotResponse. Un objeto que contiene campos de un tipo arbitrario. Un campo adicional "@type" contiene una URI que identifica el tipo. Ejemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.
|
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 2025-07-25 (UTC)"],[[["\u003cp\u003eThis resource describes the JSON representation of a long-running operation initiated by a network API call.\u003c/p\u003e\n"],["\u003cp\u003eThe representation includes fields for operation name (\u003ccode\u003ename\u003c/code\u003e), metadata (\u003ccode\u003emetadata\u003c/code\u003e), completion status (\u003ccode\u003edone\u003c/code\u003e), and result (\u003ccode\u003eresult\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eresult\u003c/code\u003e field provides either an error (\u003ccode\u003eerror\u003c/code\u003e) or a response (\u003ccode\u003eresponse\u003c/code\u003e) based on the operation outcome.\u003c/p\u003e\n"],["\u003cp\u003eWhile the operation is in progress, \u003ccode\u003edone\u003c/code\u003e is \u003ccode\u003efalse\u003c/code\u003e and neither \u003ccode\u003eerror\u003c/code\u003e nor \u003ccode\u003eresponse\u003c/code\u003e are set; upon completion, \u003ccode\u003edone\u003c/code\u003e becomes \u003ccode\u003etrue\u003c/code\u003e and either \u003ccode\u003eerror\u003c/code\u003e or \u003ccode\u003eresponse\u003c/code\u003e is populated.\u003c/p\u003e\n"]]],["This content defines the structure of a long-running operation's JSON representation. It includes fields for `name` (server-assigned identifier), `metadata` (service-specific data), and `done` (operation status). If `done` is true, the `result` field will contain either an `error` object (for failed operations) or a `response` object (for successful ones). `result` field can only contain one of them. Otherwise, it contains neither of them.\n"],null,["# Operation\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nThis resource represents a long-running operation that is the result of a network API call.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"metadata\": { \"@type\": string, field1: ..., ... }, \"done\": boolean, // Union field `result` can be only one of the following: \"error\": { object (/streetview/publish/reference/rest/v1/Status) }, \"response\": { \"@type\": string, field1: ..., ... } // End of list of possible types for union field `result`. } ``` |\n\n| Fields ||\n|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |\n| `metadata` | `object` Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. An object containing fields of an arbitrary type. An additional field `\"@type\"` contains a URI identifying the type. Example: `{ \"id\": 1234, \"@type\": \"types.example.com/standard/id\" }`. |\n| `done` | `boolean` If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |\n| Union field `result`. The operation result, which can be either an `error` or a valid `response`. If `done` == `false`, neither `error` nor `response` is set. If `done` == `true`, exactly one of `error` or `response` may be set. Some services might not provide the result. `result` can be only one of the following: ||\n| `error` | `object (`[Status](/streetview/publish/reference/rest/v1/Status)`)` The error result of the operation in case of failure or cancellation. |\n| `response` | `object` The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. An object containing fields of an arbitrary type. An additional field `\"@type\"` contains a URI identifying the type. Example: `{ \"id\": 1234, \"@type\": \"types.example.com/standard/id\" }`. |"]]
