Index
-
Operations
(Schnittstelle) -
CancelOperationRequest
(Nachricht) -
DeleteOperationRequest
(Nachricht) -
GetOperationRequest
(Nachricht) -
ListOperationsRequest
(Nachricht) -
ListOperationsResponse
(Nachricht) -
Operation
(Nachricht) -
WaitOperationRequest
(Nachricht)
Operationen
Verwaltet lang andauernde Vorgänge mit einem API-Dienst.
Wenn die Ausführung einer API-Methode normalerweise lange dauert, kann sie so konzipiert werden, dass Operation
an den Client zurückgibt, und der Client kann diese Schnittstelle verwenden, um die tatsächliche Antwort asynchron zu empfangen, indem er die Operationsressource abfragt, oder die Operationsressource an eine andere API übergeben ( B. Pub/Sub API), um die Antwort zu empfangen. Jeder API-Dienst, der lang laufende Vorgänge zurückgibt, sollte die Operations
Schnittstelle implementieren, damit Entwickler ein konsistentes Client-Erlebnis haben können.
Vorgang abbrechen |
---|
Startet den asynchronen Abbruch eines lang andauernden Vorgangs. Der Server bemüht sich nach besten Kräften, den Vorgang abzubrechen, es kann jedoch kein Erfolg garantiert werden. Wenn der Server diese Methode nicht unterstützt, gibt er
|
Löschvorgang |
---|
Löscht einen lang andauernden Vorgang. Diese Methode zeigt an, dass der Client nicht mehr am Operationsergebnis interessiert ist. Der Vorgang wird dadurch nicht abgebrochen. Wenn der Server diese Methode nicht unterstützt, gibt er
|
GetOperation |
---|
Ruft den neuesten Status eines lang andauernden Vorgangs ab. Mit dieser Methode können Clients das Operationsergebnis in den vom API-Dienst empfohlenen Abständen abfragen.
|
ListOperations |
---|
Listet Vorgänge auf, die dem angegebenen Filter in der Anfrage entsprechen. Wenn der Server diese Methode nicht unterstützt, gibt er
|
WaitOperation |
---|
Wartet, bis der angegebene lang andauernde Vorgang abgeschlossen ist oder höchstens ein angegebenes Zeitlimit erreicht, und gibt den neuesten Status zurück. Wenn der Vorgang bereits abgeschlossen ist, wird sofort der neueste Status zurückgegeben. Wenn das angegebene Zeitlimit größer als das standardmäßige HTTP/RPC-Zeitlimit ist, wird das HTTP/RPC-Zeitlimit verwendet. Wenn der Server diese Methode nicht unterstützt, gibt er
|
CancelOperationRequest
Die Anforderungsnachricht für Operations.CancelOperation
.
Felder | |
---|---|
name | Der Name der Vorgangsressource, die abgebrochen werden soll. |
DeleteOperationRequest
Die Anforderungsnachricht für Operations.DeleteOperation
.
Felder | |
---|---|
name | Der Name der zu löschenden Vorgangsressource. |
GetOperationRequest
Die Anforderungsnachricht für Operations.GetOperation
.
Felder | |
---|---|
name | Der Name der Operationsressource. |
ListOperationsRequest
Die Anforderungsnachricht für Operations.ListOperations
.
Felder | |
---|---|
name | Der Name der übergeordneten Ressource des Vorgangs. |
filter | Der Standardlistenfilter. |
page_size | Die Standardseitengröße der Liste. |
page_token | Das Standard-Listenseiten-Token. |
ListOperationsResponse
Die Antwortnachricht für Operations.ListOperations
.
Felder | |
---|---|
operations[] | Eine Liste von Vorgängen, die dem angegebenen Filter in der Anfrage entsprechen. |
next_page_token | Das Standard-Token „Nächste Seite auflisten“. |
Betrieb
Diese Ressource stellt einen lang andauernden Vorgang dar, der das Ergebnis eines Netzwerk-API-Aufrufs ist.
Felder | |
---|---|
name | Der vom Server zugewiesene Name, der nur innerhalb desselben Dienstes eindeutig ist, der ihn ursprünglich zurückgibt. Wenn Sie die Standard-HTTP-Zuordnung verwenden, sollte der |
metadata | Dienstspezifische Metadaten, die dem Vorgang zugeordnet sind. Es enthält normalerweise Fortschrittsinformationen und allgemeine Metadaten wie die Erstellungszeit. Einige Dienste stellen solche Metadaten möglicherweise nicht bereit. Jede Methode, die einen lang andauernden Vorgang zurückgibt, sollte gegebenenfalls den Metadatentyp dokumentieren. |
done | Wenn der Wert |
Union- result . Das Operationsergebnis, das entweder ein error oder eine gültige response sein kann. Wenn done == false , wird weder error noch response gesetzt. Wenn done == true , kann genau entweder error oder response festgelegt werden. Einige Dienste liefern möglicherweise nicht das Ergebnis. result kann nur eines der folgenden sein: | |
error | Das Fehlerergebnis des Vorgangs im Falle eines Fehlers oder Abbruchs. |
response | Die normale, erfolgreiche Reaktion des Vorgangs. Wenn die ursprüngliche Methode keine Erfolgsdaten zurückgibt, z. B. |
WaitOperationRequest
Die Anforderungsnachricht für Operations.WaitOperation
.
Felder | |
---|---|
name | Der Name der Operationsressource, auf die gewartet werden soll. |
timeout | Die maximale Wartezeit, bevor das Zeitlimit überschritten wird. Wenn das Feld leer bleibt, beträgt die Wartezeit höchstens die Zeit, die das zugrunde liegende HTTP/RPC-Protokoll zulässt. Wenn auch die Frist für den RPC-Kontext angegeben ist, wird die kürzere Frist verwendet. |