REST-Ressource: operations

Ressource: Vorgang

Diese Ressource steht für einen lange laufenden Vorgang, der das Ergebnis eines Netzwerk-API-Aufrufs ist.

JSON-Darstellung

{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // Union field result can be only one of the following:
  "error": {
    object(Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}
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

object

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.

Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI, der den Typ bestimmt. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }.

done

boolean

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

object(Status)

Das Fehlerergebnis des Vorgangs, falls ein Fehler auftritt oder er abgebrochen wird.

response

object

Die normale Antwort des Vorgangs im Erfolgsfall. Falls die ursprüngliche Methode im Erfolgsfall keine Daten zurückgibt, z. B. Delete, ist die Antwort google.protobuf.Empty. Ist die ursprüngliche Methode Standard-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.

Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI, der den Typ bestimmt. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }.

Methoden

get

Ruft den letzten Status eines lange laufende Vorgangs ab.

list

Listet Vorgänge auf, die zum angegebenen Filter in der Anfrage passen.
Hat Ihnen diese Seite weitergeholfen? Teilen Sie uns Ihr Feedback mit:

Feedback geben zu...