Package google.longrunning

Index

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

rpc CancelOperation( CancelOperationRequest ) returns ( Empty )

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 google.rpc.Code.UNIMPLEMENTED zurück. Clients können Operations.GetOperation oder andere Methoden verwenden, um zu überprüfen, ob der Abbruch erfolgreich war oder ob der Vorgang trotz Abbruch abgeschlossen wurde. Bei erfolgreichem Abbruch wird der Vorgang nicht gelöscht; Stattdessen wird es zu einer Operation mit einem Operation.error Wert und einem google.rpc.Status.code von 1, entsprechend Code.CANCELLED .

Berechtigungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht .

Löschvorgang

rpc DeleteOperation( DeleteOperationRequest ) returns ( Empty )

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 google.rpc.Code.UNIMPLEMENTED zurück.

Berechtigungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht .

GetOperation

rpc GetOperation( GetOperationRequest ) returns ( Operation )

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.

Berechtigungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht .

ListOperations

rpc ListOperations( ListOperationsRequest ) returns ( ListOperationsResponse )

Listet Vorgänge auf, die dem angegebenen Filter in der Anfrage entsprechen. Wenn der Server diese Methode nicht unterstützt, gibt er UNIMPLEMENTED zurück.

Berechtigungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht .

WaitOperation

rpc WaitOperation( WaitOperationRequest ) returns ( Operation )

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 google.rpc.Code.UNIMPLEMENTED zurück. Beachten Sie, dass diese Methode auf der Best-Effort-Basis basiert. Es kann den neuesten Status vor dem angegebenen Timeout (auch sofort) zurückgeben, was bedeutet, dass selbst eine sofortige Antwort keine Garantie dafür ist, dass der Vorgang abgeschlossen ist.

Berechtigungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht .

CancelOperationRequest

Die Anforderungsnachricht für Operations.CancelOperation .

Felder
name

string

Der Name der Vorgangsressource, die abgebrochen werden soll.

DeleteOperationRequest

Die Anforderungsnachricht für Operations.DeleteOperation .

Felder
name

string

Der Name der zu löschenden Vorgangsressource.

GetOperationRequest

Die Anforderungsnachricht für Operations.GetOperation .

Felder
name

string

Der Name der Operationsressource.

ListOperationsRequest

Die Anforderungsnachricht für Operations.ListOperations .

Felder
name

string

Der Name der übergeordneten Ressource des Vorgangs.

filter

string

Der Standardlistenfilter.

page_size

int32

Die Standardseitengröße der Liste.

page_token

string

Das Standard-Listenseiten-Token.

ListOperationsResponse

Die Antwortnachricht für Operations.ListOperations .

Felder
operations[]

Operation

Eine Liste von Vorgängen, die dem angegebenen Filter in der Anfrage entsprechen.

next_page_token

string

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

string

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 name ein Ressourcenname sein, der mit operations/{unique_id} endet.

metadata

Any

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

bool

Wenn der Wert false ist, bedeutet dies, dass der Vorgang noch ausgeführt wird. Bei true ist der Vorgang abgeschlossen und es ist entweder error oder response verfügbar.

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

Status

Das Fehlerergebnis des Vorgangs im Falle eines Fehlers oder Abbruchs.

response

Any

Die normale, erfolgreiche Reaktion des Vorgangs. Wenn die ursprüngliche Methode keine Erfolgsdaten zurückgibt, z. B. Delete , lautet die Antwort google.protobuf.Empty . Wenn die ursprüngliche Methode die Standardmethode Get / Create / Update ist, sollte die Antwort die Ressource sein. Bei anderen Methoden sollte die Antwort den Typ XxxResponse haben, wobei Xxx der ursprüngliche Methodenname ist. Wenn der ursprüngliche Methodenname beispielsweise TakeSnapshot() lautet, ist der abgeleitete Antworttyp TakeSnapshotResponse .

WaitOperationRequest

Die Anforderungsnachricht für Operations.WaitOperation .

Felder
name

string

Der Name der Operationsressource, auf die gewartet werden soll.

timeout

Duration

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.