Sammlung: projects.configs.operations

Ressource: Vorgang

Diese Ressource steht für einen lange laufenden Vorgang, der das Ergebnis eines Netzwerk-API-Anrufs 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 von Server zugeordnete Name, der nur in dem Dienst wirklich eindeutig ist, von dem er ursprünglich zurückgegeben wird. Wenn Sie die HTTP-Standardzuordnung verwenden, sollte der name das Format operations/some/unique/name haben.

metadata

object

Mit dem Vorgang verbundene dienstspezifische Metadaten. Sie enthalten normalerweise Statusdaten und allgemeine Metadaten wie die Erstellungszeit. Diese Metadaten werden nicht von allen Diensten bereitgestellt. Methoden, die einen lange laufenden Vorgang zurückgeben, sollten gegebenenfalls den Metadatentyp dokumentieren.

Ein Objekt, das Felder eines beliebigen Typs enthält. Eine zusätzliches Feld "@type" enthält einen URI zur Identifikation des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }.
done

boolean

Wenn der Wert false ist, läuft der Vorgang noch. Wenn er "true" ist, wird der Vorgang abgeschlossen und entweder error oder response ist verfügbar.

Union-Feld result. Das Ergebnis des Vorgangs, das entweder ein error oder eine gültige response sein kann. Wenn done == false, ist weder error noch response gesetzt. Wenn done == true, ist entweder error oder response gesetzt. result kann nur einer der folgenden Werte sein:
error

object(Status)

Das Fehlerergebnis des Vorgangs bei einem Fehler oder Abbruch.

response

object

Die normale Antwort des Vorgangs im Erfolgsfall. Wenn von der ursprünglichen Methode bei Erfolg keine Daten zurückgegeben werden, zum Beispiel Delete, ist die Antwort google.protobuf.Empty. Wenn die ursprüngliche Methode standardmäßig Get/Create/Update ist, sollte die Antwort die Ressource sein. Für andere Methoden sollte die Antwort den Typ XxxResponse haben, bei dem Xxx der ursprüngliche Methodenname ist. Bei einem ursprünglichen Methodenname von TakeSnapshot() ist der gefolgerte Antworttyp beispielsweise TakeSnapshotResponse.

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

Methoden

get

 Ruft den letzten Status eines lange laufende Vorgangs ab.