Package google.longrunning
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Operación
Este recurso representa una operación de larga duración que es el resultado de una llamada a la API de la red.
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 |
Any
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.
|
done |
bool
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 establece error o response . result puede ser uno de los siguientes: |
error |
Status
El resultado de error de la operación en caso de falla o cancelación.
|
response |
Any
La respuesta normal de la operación en caso de éxito. 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 .
|
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\u003eThe \u003ccode\u003eOperation\u003c/code\u003e resource represents a long-running operation initiated by a network API call, containing details about its progress and outcome.\u003c/p\u003e\n"],["\u003cp\u003eOperations are identified by a unique \u003ccode\u003ename\u003c/code\u003e and can include service-specific \u003ccode\u003emetadata\u003c/code\u003e for progress tracking.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003edone\u003c/code\u003e field indicates operation completion status, with \u003ccode\u003eerror\u003c/code\u003e or \u003ccode\u003eresponse\u003c/code\u003e providing details upon completion.\u003c/p\u003e\n"],["\u003cp\u003eThe operation's outcome is represented by either an \u003ccode\u003eerror\u003c/code\u003e object for failures or a \u003ccode\u003eresponse\u003c/code\u003e object for successes, depending on the original method's expected return type.\u003c/p\u003e\n"]]],["The `Operation` message represents a long-running network API call. It includes a server-assigned `name` and `metadata` for progress and details. The `done` field indicates if the operation is complete. The `result` field, a union, contains either an `error` status or a successful `response`. If `done` is false, both `error` and `response` are unset. If `done` is true, only one of the two fields will have a value.\n"],null,["# Package google.longrunning\n\nIndex\n-----\n\n- [Operation](/spectrum-access-system/reference/rpc/google.longrunning#google.longrunning.Operation) (message)\n\nOperation\n---------\n\nThis resource represents a long-running operation that is the result of a network API call.\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` | [Any](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Any) 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. |\n| `done` | `bool` 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` is set. `result` can be only one of the following: |||\n| `error` | [Status](/spectrum-access-system/reference/rpc/google.rpc#google.rpc.Status) The error result of the operation in case of failure or cancellation. |\n| `response` | [Any](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Any) The normal response of the operation in case of success. 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`. |"]]