Index
Operations
(Benutzeroberfläche)CancelOperationRequest
(Meldung)DeleteOperationRequest
(Meldung)GetOperationRequest
(Meldung)ListOperationsRequest
(Meldung)ListOperationsResponse
(Meldung)Operation
(Meldung)WaitOperationRequest
(Meldung)
Operations
Verwaltet lang andauernde Vorgänge mit einem API-Dienst.
Wenn die Ausführung einer API-Methode in der Regel lange dauert, kann sie so gestaltet werden, dass sie Operation
an den Client zurückgibt. Der Client kann dann diese Schnittstelle verwenden, um die echte Antwort asynchron durch Abfragen der Vorgangsressource zu empfangen oder die Vorgangsressource an eine andere API (z. B. die Pub/Sub API) zu übergeben, um die Antwort zu erhalten. Jeder API-Dienst, der lang andauernde Vorgänge zurückgibt, sollte die Operations
-Schnittstelle implementieren, damit Entwickler eine konsistente Clientumgebung erhalten.
CancelOperation |
---|
Startet den asynchronen Abbruch eines lang andauernden Vorgangs. Der Server unternimmt alles, um den Vorgang abzubrechen, aber der Erfolg kann nicht garantiert werden. Wenn der Server diese Methode nicht unterstützt, wird
|
DeleteOperation |
---|
Löscht einen lang andauernden Vorgang. Diese Methode zeigt an, dass der Client kein Interesse mehr an dem Ergebnis eines Vorgangs hat. Der Vorgang wird nicht abgebrochen. Wenn der Server diese Methode nicht unterstützt, wird
|
GetOperation |
---|
Letzten Status eines lang andauernden Vorgangs abrufen. Clients können diese Methode nutzen, um die Ergebnisse eines Vorgangs nach gewissen Zeitabständen zu testen, wie vom API-Dienst empfohlen.
|
ListOperations |
---|
Listet Vorgänge, die zu dem angegebenen Filter in der Anfrage passen Wenn der Server diese Methode nicht unterstützt, wird
|
WaitOperation |
---|
Wartet, bis der angegebene lang andauernde Vorgang abgeschlossen ist, oder erreicht höchstens eine angegebene Zeitüberschreitung und gibt den letzten Status zurück. Wenn der Vorgang bereits ausgeführt wurde, wird der letzte Status sofort zurückgegeben. Wenn das angegebene Zeitlimit größer als das HTTP/RPC-Standardzeitlimit ist, wird das HTTP/RPC-Zeitlimit verwendet. Wenn der Server diese Methode nicht unterstützt, wird
|
CancelOperationRequest
Die Anfragenachricht für Operations.CancelOperation
.
Felder | |
---|---|
name |
Der Name der abzubrechenden Vorgangsressource. |
DeleteOperationRequest
Die Anfragenachricht für Operations.DeleteOperation
.
Felder | |
---|---|
name |
Der Name der zu löschenden Vorgangsressource. |
GetOperationRequest
Die Anfragenachricht für Operations.GetOperation
.
Felder | |
---|---|
name |
Der Name der Vorgangsressource. |
ListOperationsRequest
Die Anfragenachricht für Operations.ListOperations
.
Felder | |
---|---|
name |
Der Name der übergeordneten Ressource des Vorgangs. |
filter |
Der Standard-Listenfilter |
page_size |
Die Standardgröße der Listenseite |
page_token |
Das Standardtoken der Listenseite. |
ListOperationsResponse
Die Antwortnachricht für Operations.ListOperations
.
Felder | |
---|---|
operations[] |
Eine Liste der Vorgänge, die zu dem angegebenen Filter in der Anfrage passen. |
next_page_token |
Das Standardtoken für die nächste Listenseite. |
Vorgang
Diese Ressource steht für einen lange laufenden Vorgang, der das Ergebnis eines Netzwerk-API-Aufrufs ist.
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 |
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 |
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 , kann genau 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 |
Das Fehlerergebnis des Vorgangs im Fall eines Fehlers oder Abbruchs. |
response |
Die normale, erfolgreiche Antwort des Vorgangs. Wenn die ursprüngliche Methode im Erfolgsfall keine Daten zurückgibt, wie bei |
WaitOperationRequest
Die Anfragenachricht für Operations.WaitOperation
.
Felder | |
---|---|
name |
Der Name der Vorgangsressource, auf die gewartet werden soll. |
timeout |
Die maximale Wartezeit vor Überschreiten des Zeitlimits. Wenn dieser Wert leer gelassen wird, ist die maximale Wartezeit die Zeit, die das zugrunde liegende HTTP/RPC-Protokoll zulässt. Wird die RPC-Kontextfrist ebenfalls angegeben, gilt die jeweils kürzere Zeitspanne. |