Operation
Diese Ressource stellt einen lange laufenden Vorgang dar, der das Ergebnis eines Netzwerk-API-Aufrufs ist.
JSON-Darstellung |
{
"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 .
} |
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 |
object
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. Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" } .
|
done |
boolean
Ist der Wert false , bedeutet das, 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 , kann entweder error oder response festgelegt werden. Einige Dienste liefern das Ergebnis möglicherweise nicht. Für result ist nur einer der folgenden Werte zulässig: |
error |
object (Status )
Das Fehlerergebnis des Vorgangs im Fall eines Fehlers oder Abbruchs.
|
response |
object
Die normale, erfolgreiche Antwort des Vorgangs. 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. Wenn zum Beispiel der Name der ursprünglichen Methode TakeSnapshot() ist, ist der gefolgerte Antworttyp TakeSnapshotResponse . Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" } .
|
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: 2024-09-10 (UTC).
[null,null,["Zuletzt aktualisiert: 2024-09-10 (UTC)."],[[["This resource describes the JSON representation of a long-running operation initiated by a network API call."],["The representation includes fields for operation name (`name`), metadata (`metadata`), completion status (`done`), and result (`result`)."],["The `result` field provides either an error (`error`) or a response (`response`) based on the operation outcome."],["While the operation is in progress, `done` is `false` and neither `error` nor `response` are set; upon completion, `done` becomes `true` and either `error` or `response` is populated."]]],[]]