REST Resource: projects.locations.operations

Ressource: Vorgang

Diese Ressource steht für einen Vorgang mit langer Ausführungszeit, 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. Wenn Sie die Standard-HTTP-Zuordnung verwenden, sollte name ein Ressourcenname sein, der auf operations/{uniqueId} endet.
metadata

object

{

createTime: Die Zeit, zu der der Vorgang erstellt wurde.

endTime: Der Zeitpunkt, zu dem der Vorgang abgeschlossen wurde.

target: Serverdefinierter Ressourcenpfad für das Ziel des Vorgangs.

verb: Name des vom Vorgang ausgeführten Verbs.

statusDetail: Lesbarer Status des Vorgangs, falls vorhanden.

cancelRequested: Gibt an, ob der Nutzer die Beendigung des Vorgangs angefordert hat. Vorgänge, die erfolgreich abgebrochen wurden, haben den Wert Operation.error mit einem google.rpc.Status.code von 1, was Code.CANCELLED entspricht.

apiVersion: Die API-Version, die zum Starten des Vorgangs verwendet wurde.

}
done

boolean

Ist der Wert false, bedeutet das, 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

object (Status)

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

object

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.

Methoden

cancel

 Startet den asynchronen Abbruch eines Vorgangs mit langer Ausführungszeit

delete

 Löscht einen Vorgang mit langer Ausführungszeit

get

 Ruft den letzten Status eines Vorgangs mit langer Ausführungszeit ab

list

 Listet Vorgänge, die zu dem angegebenen Filter in der Anfrage passen