Package google.longrunning

Index

• Operations (Benutzeroberfläche)
• CancelOperationRequest (Meldung)
• GetOperationRequest (Meldung)
• ListOperationsRequest (Meldung)
• ListOperationsResponse (Meldung)
• Operation (Meldung)

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 diese Schnittstelle dann verwenden, um die echte Antwort asynchron durch Abfragen der Vorgangsressource zu empfangen oder die Vorgangsressource an eine andere API (zum Beispiel 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/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite Weitere Informationen finden Sie unter Authentication Overview.

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 einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: discoveryengine.operations.get Weitere Informationen finden Sie in der IAM-Dokumentation.

ListOperations

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse) Listet Vorgänge auf, die zu dem in der Anfrage angegebenen Filter passen Wenn der Server diese Methode nicht unterstützt, wird UNIMPLEMENTED zurückgegeben. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: discoveryengine.operations.list Weitere Informationen finden Sie in der IAM-Dokumentation.

CancelOperationRequest

Die Anfragenachricht für Operations.CancelOperation.

Felder
name	string Der Name der abzubrechenden 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 und nicht erreichbare Vorgänge im Feld [ListOperationsResponse.unreachable]. Dies kann nur true sein, wenn Daten aus mehreren Sammlungen gelesen werden, z.B. wenn parent auf "projects/example/locations/-" gesetzt ist. 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 im Antrag ListOperationsRequest.return_partial_success festgelegt ist und über Sammlungen hinweg gelesen wird, z.B. 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. Wenn zum Beispiel der Name der ursprünglichen Methode TakeSnapshot() ist, ist der gefolgerte Antworttyp TakeSnapshotResponse.