Package google.longrunning

Index

Operations

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

Wenn eine API-Methode in der Regel viel Zeit in Anspruch nimmt, kann sie so gestaltet 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 zurückgibt, sollte die Operations-Schnittstelle implementieren, damit Entwickler eine konsistente Clientumgebung erhalten.

CancelOperation

rpc CancelOperation(CancelOperationRequest) returns (Empty)

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 google.rpc.Code.UNIMPLEMENTED zurückgegeben. Kunden können Operations.GetOperation oder andere Methoden verwenden, um zu prüfen, ob der Abbruch erfolgreich war oder der Vorgang dennoch abgeschlossen wurde. Bei erfolgreichem Abbruch wird der Vorgang nicht gelöscht. Stattdessen wird daraus ein Vorgang mit einem Operation.error-Wert mit einem google.rpc.Status.code von 1, was Code.CANCELLED entspricht.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
DeleteOperation

rpc DeleteOperation(DeleteOperationRequest) returns (Empty)

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

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
GetOperation

rpc GetOperation(GetOperationRequest) returns (Operation)

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.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
ListOperations

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

Listet Vorgänge, die zu dem angegebenen Filter in der Anfrage passen Wenn der Server diese Methode nicht unterstützt, wird UNIMPLEMENTED zurückgegeben.

HINWEIS: Die Bindung name ermöglicht API-Diensten, die Bindung zu überschreiben, um andere Schemas für die Ressourcennamen wie users/*/operations zu verwenden. Zum Überschreiben der Bindung 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 möchten, müssen jedoch sichergehen, dass der bindende Name aus der übergeordneten Ressource und nicht aus der Sammlungs-ID der Vorgänge kommt.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
WaitOperation

rpc WaitOperation(WaitOperationRequest) returns (Operation)

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, wird google.rpc.Code.UNIMPLEMENTED zurückgegeben. Beachten Sie, dass diese Methode auf Best-Effort-Basis durchgeführt wird. Möglicherweise 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 einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/jobs
  • 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

Der Standard-Listenfilter
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. Wenn Sie die Standard-HTTP-Zuordnung verwenden, sollte name ein Ressourcenname sein, der auf operations/{unique_id} endet.
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, bedeutet dies, dass der Vorgang noch läuft. Ist der Wert hingegen true, ist der Vorgang abgeschlossen und entweder error oder response ist verfügbar.
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, wird genau ein error oder eine response festgelegt. Für result ist nur einer der folgenden Werte zulässig:
error

Status

Das Fehlerergebnis des Vorgangs im Fall eines Fehlers oder Abbruchs.
response

Any

Die normale Antwort des Vorgangs im Erfolgsfall. Wenn die ursprüngliche Methode im Erfolgsfall keine Daten zurückgibt, wie bei 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. Lautet der ursprüngliche Methodenname beispielsweise TakeSnapshot(), ist der abgeleitete 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.