Package google.longrunning

Index

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 gestaltet werden, dass sie Operation an den Client zurückgibt. Der Client kann über diese Schnittstelle dann die echte Antwort asynchron durch Abfragen der Vorgangsressource empfangen oder die Vorgangsressource an eine andere API (z. B. Google Cloud Pub/Sub API) ü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)

(Derzeit nicht unterstützt) Startet den asynchronen Abbruch eines Vorgangs mit langer Ausführungszeit.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc DeleteOperation(DeleteOperationRequest) returns (Empty)

(Derzeit nicht unterstützt) Löscht einen Vorgang mit langer Ausführungszeit.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc GetOperation(GetOperationRequest) returns (Operation)

Ruft den letzten Status eines Vorgangs mit langer Ausführungszeit 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
IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource name:

  • routeoptimization.operations.get

Weitere Informationen finden Sie in der IAM-Dokumentation.
ListOperations

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

(Derzeit nicht unterstützt) Listet Vorgänge auf, die zu dem angegebenen Filter in der Anfrage passen.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc WaitOperation(WaitOperationRequest) returns (Operation)

(Derzeit nicht unterstützt) Wartet, bis der angegebene Vorgang mit langer Ausführungszeit abgeschlossen wurde oder bis er eine angegebene Zeitüberschreitung erreicht, und gibt den letzten Status zurück.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

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
return_partial_success

bool

Wenn der Wert auf true festgelegt ist, werden erreichbare Vorgänge normal zurückgegeben. Nicht erreichbare Vorgänge werden im Feld ListOperationsResponse.unreachable zurückgegeben.

Dies kann nur true sein, wenn Daten aus mehreren Sammlungen gelesen werden. Beispiel: Für parent ist "projects/example/locations/-" festgelegt.

Dieses Feld wird standardmäßig nicht unterstützt. Wenn es festgelegt ist, wird der Fehler UNIMPLEMENTED zurückgegeben, sofern in der dienst- oder produktspezifischen Dokumentation nicht ausdrücklich anders angegeben.

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.
unreachable[]

string

Unsortierte Liste. Nicht erreichbare Ressourcen. Wird ausgefüllt, wenn in der Anfrage ListOperationsRequest.return_partial_success festgelegt ist und sammlungsübergreifend gelesen wird. Zum Beispiel beim Versuch, alle Ressourcen an allen unterstützten Standorten aufzulisten.

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, kann genau ein error oder eine response festgelegt werden. Einige Dienste stellen das Ergebnis möglicherweise nicht bereit. 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, erfolgreiche Antwort des Vorgangs. 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.