Paket google.longrunning

Index

• Operations (Schnittstelle)
• CancelOperationRequest (Nachricht)
• DeleteOperationRequest (Nachricht)
• GetOperationRequest (Nachricht)
• ListOperationsRequest (Nachricht)
• ListOperationsResponse (Nachricht)
• Operation (Nachricht)
• WaitOperationRequest (Nachricht)

Vorgänge

Verwaltet lang andauernde Vorgänge mit einem API-Dienst.

Wenn eine API-Methode in der Regel viel Zeit in Anspruch nimmt, kann sie so konzipiert werden, dass sie Operation an den Client zurückgibt. Der Client kann diese Schnittstelle dann verwenden, um die echte Antwort asynchron durch Abfragen der Vorgangsressource zu empfangen oder die Vorgangsressource an eine andere API (zum Beispiel Google Cloud Pub/Sub API) zu übergeben, damit diese die Antwort erhält. Jeder API-Dienst, der lang andauernde Vorgänge liefert, sollte die Operations-Schnittstelle implementieren, damit Entwickler eine konsistente Client-Umgebung erhalten.

CancelOperation

rpc CancelOperation (CancelOperationRequest) gibt (Empty) zurück 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, gibt er google.rpc.Code.UNIMPLEMENTED zurück. Clients können Operations.GetOperation oder andere Methoden verwenden, um zu prüfen, ob der Abbruch erfolgreich war oder ob der Vorgang trotz des Abbruchs abgeschlossen wurde. Bei erfolgreichem Abbruch wird der Vorgang nicht gelöscht. Stattdessen wird er zu einem Vorgang mit dem Wert Operation.error und einem google.rpc.Status.code von 1, was Code.CANCELLED entspricht. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie in der Authentifizierungsübersicht.

DeleteOperation

rpc DeleteOperation (DeleteOperationRequest) gibt (Empty) zurück 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, gibt er google.rpc.Code.UNIMPLEMENTED zurück. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie in der Authentifizierungsübersicht.

GetOperation

rpc GetOperation(GetOperationRequest) gibt (Operation) zurück Ruft den letzten Status eines lang andauernden Vorgangs ab. Clients können diese Methode nutzen, um die Ergebnisse eines Vorgangs nach gewissen Zeitabständen zu testen, wie vom API-Dienst empfohlen. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie in der Authentifizierungsübersicht.

ListOperations

rpc ListOperations (ListOperationsRequest) gibt (ListOperationsResponse) zurück Listet Vorgänge auf, die zum angegebenen Filter in der Anfrage passen. Falls der Server diese Methode nicht unterstützt, gibt er UNIMPLEMENTED zurück. HINWEIS: Die Bindung name ermöglicht es API-Diensten, die Bindung zu überschreiben, um andere Schemas für Ressourcennamen wie z. B. users/*/operations zu nutzen. Um die Bindung zu überschreiben, können API-Dienste eine Bindung wie "/v1/{name=users/*}/operations" zu ihrer Dienstkonfiguration hinzufügen. Der Standardname für die Abwärtskompatibilität enthält die Sammlungs-ID der Vorgänge. Nutzer, die die Bindung überschreiben wollen, müssen jedoch sichergehen, dass der bindende Name aus der übergeordneten Ressource kommt und nicht aus der Sammlungs-ID der Vorgänge. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie in der Authentifizierungsübersicht.

WaitOperation

rpc WaitOperation (WaitOperationRequest) gibt (Operation) zurück Wartet auf den angegebenen, lang andauernden Vorgang bis zu dessen Abschluss 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, gibt er google.rpc.Code.UNIMPLEMENTED zurück. Diese Methode wird auf Best-Effort-Basis durchgeführt. Unter Umständen wird der letzte Status vor dem angegebenen Zeitlimit (einschließlich "sofort") zurückgegeben. Dies bedeutet, dass selbst eine sofortige Antwort keine Garantie dafür ist, dass der Vorgang abgeschlossen ist. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie in der Authentifizierungsübersicht.

CancelOperationRequest

Die Anfragenachricht für Operations.CancelOperation.

Felder
name	string Der Name der abzubrechenden Vorgangsressource.

DeleteOperationRequest

Die Anfragenachricht für Operations.DeleteOperation.

Felder
name	string Der Name der zu löschenden Vorgangsressource.

GetOperationRequest

Die Anfragenachricht für Operations.GetOperation.

Felder
name	string Der Name der Vorgangsressource.

ListOperationsRequest

Die Anfragenachricht für Operations.ListOperations.

Felder
name	string Der Name der übergeordneten Ressource des Vorgangs.
filter	string Ein Ausdruck zum Filtern der Anfrageergebnisse. operation_id – für = oder !=. done – für = oder !=. works_on – für = oder !=. Einige Beispiele für die Verwendung des Filters: done=true –> Vorgang wurde abgeschlossen. worksOn = projects/my-project/locations/us-central1/datasets/5 –> Vorgang arbeitet an einem Dataset mit der ID 5. worksOn = projects/my-project/locations/us-central1/models/15 –> Vorgang arbeitet an einem Modell mit der ID 15.
page_size	int32 Die Standardgröße der Listenseite.
page_token	string Das Standardtoken der Listenseite.

ListOperationsResponse

Die Antwortnachricht für Operations.ListOperations.

Felder
operations[]	Operation Eine Liste der Vorgänge, die zu dem angegebenen Filter in der Anfrage passen.
next_page_token	string 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	string Der vom Server zugewiesene Name, der nur innerhalb des Dienstes eindeutig ist, der ihn ursprünglich zurückgibt. Falls Sie die Standard-HTTP-Zuordnung nutzen, sollte der name folgendes Format haben: operations/some/unique/name.
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, heißt das, dass der Vorgang noch läuft. Beim Wert true ist der Vorgang abgeschlossen und es stehen die Optionen error oder response zur Verfügung.
Union-Feld result: Das Ergebnis des Vorgangs kann entweder ein error oder eine gültige response sein. Wenn done == false, ist weder error noch response festgelegt. Wenn done == true, ist einer von error oder response festgelegt. result kann nur einer der Folgenden sein:
error	Status Das Fehlerergebnis des Vorgangs, falls ein Fehler auftritt oder er abgebrochen wird.
response	Any Die normale Antwort des Vorgangs im Erfolgsfall. Wenn die ursprüngliche Methode im Erfolgsfall keine Daten zurückgibt, wie zum Beispiel 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.

WaitOperationRequest

Die Anfragenachricht für Operations.WaitOperation.

Felder
name	string Der Name der Vorgangsressource, auf die gewartet werden soll.
timeout	Duration 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.