Package google.longrunning
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Vorgang
Diese Ressource steht für einen lange laufenden Vorgang, der das Ergebnis eines Netzwerk-API-Aufrufs ist.
| Felder |
name |
string
Der vom Server zugewiesene Name, der nur innerhalb des Dienstes eindeutig ist, der ihn ursprünglich zurückgibt. Wenn Sie die Standard-HTTP-Zuordnung verwenden, sollte name ein Ressourcenname sein, der auf operations/{unique_id} endet.
|
metadata |
Any
Dienstspezifische Metadaten, die mit dem Vorgang verknüpft sind. Typischerweise enthalten sie Informationen zum Verlauf und gemeinsame Metadaten wie den Erstellungszeitpunkt. Solche Metadaten werden nicht von allen Diensten bereitgestellt. Jede Methode, die einen lange laufenden Vorgang zurückgibt, sollte gegebenenfalls den Metadatentyp dokumentieren.
|
done |
bool
Ist der Wert false, bedeutet dies, dass der Vorgang noch läuft. Ist der Wert hingegen true, ist der Vorgang abgeschlossen und entweder error oder response ist verfügbar.
|
Union-Feld result. Das Ergebnis des Vorgangs kann entweder ein error oder eine gültige response sein. Wenn done = false ist, wird weder error noch response festgelegt. Wenn done = true ist, wird genau ein error oder eine response festgelegt. Für result ist nur einer der folgenden Werte zulässig: |
error |
Status
Das Fehlerergebnis des Vorgangs im Fall eines Fehlers oder Abbruchs.
|
response |
Any
Die normale Antwort des Vorgangs im Erfolgsfall. Wenn die ursprüngliche Methode im Erfolgsfall keine Daten zurückgibt, wie bei Delete, lautet die Antwort google.protobuf.Empty. Ist die ursprüngliche Methode standardmäßig Get/Create/Update, sollte die Antwort die Ressource sein. Bei anderen Methoden sollte die Antwort vom Typ XxxResponse sein, wobei Xxx der Name der ursprünglichen Methode ist. Lautet der ursprüngliche Methodenname beispielsweise TakeSnapshot(), ist der abgeleitete Antworttyp TakeSnapshotResponse.
|
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-25 (UTC).
[null,null,["Zuletzt aktualisiert: 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`. |"]]
