Ressource: Vorgang
Diese Ressource steht für einen lange laufenden Vorgang, der das Ergebnis eines Netzwerk-API-Aufrufs ist.
JSON-Darstellung |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
Felder | |
---|---|
name |
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 |
metadata |
Ein Ein Objekt mit Feldern eines beliebigen Typs. Ein zusätzliches Feld |
done |
Ist der Wert |
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, kann genau einer der Werte error oder response festgelegt werden. Einige Dienste liefern möglicherweise nicht das Ergebnis. Für result ist nur einer der folgenden Werte zulässig: |
|
error |
Das Fehlerergebnis des Vorgangs im Fall eines Fehlers oder Abbruchs. |
response |
Ein Ein Objekt mit Feldern eines beliebigen Typs. Ein zusätzliches Feld |
Status
Mit dem Typ Status
wird ein logisches Fehlermodell definiert, das für verschiedene Programmierumgebungen wie REST APIs und RPC APIs geeignet ist. Dieses Modell wird von gRPC verwendet. Jede Status
-Meldung enthält die folgenden drei Datenelemente: Fehlercode, Fehlermeldung und Fehlerdetails.
Weitere Informationen zu diesem Fehlermodell und zur Arbeit damit finden Sie in der API-Designanleitung.
JSON-Darstellung |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Felder | |
---|---|
code |
Der Statuscode, der idealerweise ein ENUM-Wert von |
message |
Eine an Entwickler gerichtete Fehlermeldung, die englischsprachig sein sollte. Jede Fehlermeldung an den Nutzer sollte lokalisiert und im Feld |
details[] |
Eine Auflistung aller Meldungen, die die Fehlerdetails enthalten. Es gibt einen gemeinsamen Satz von Nachrichtentypen, die APIs verwenden können. Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld |
Methoden |
|
---|---|
|
Startet den asynchronen Abbruch eines lang andauernden Vorgangs |
|
Löscht einen lang andauernden Vorgang. |
|
Ruft den letzten Status eines lang andauernden Vorgangs ab. |
|
Listet Vorgänge, die zu dem angegebenen Filter in der Anfrage passen |
|
Wartet, bis der angegebene lang andauernde Vorgang abgeschlossen ist oder das angegebene Zeitlimit erreicht ist, wobei der letzte Status zurückgegeben wird. |