REST Resource: operations

Ressource: Betrieb

Diese Ressource stellt einen lang andauernden Vorgang dar, 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 desselben Dienstes eindeutig ist, der ihn ursprünglich zurückgibt. Wenn Sie die Standard-HTTP-Zuordnung verwenden, sollte der name ein Ressourcenname sein, der mit operations/{unique_id} endet.

metadata

object

Dienstspezifische Metadaten, die dem Vorgang zugeordnet sind. Es enthält normalerweise Fortschrittsinformationen und allgemeine Metadaten wie die Erstellungszeit. Einige Dienste stellen solche Metadaten möglicherweise nicht bereit. Jede Methode, die einen lang andauernden 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 identifiziert. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" } .

done

boolean

Wenn der Wert false ist, bedeutet dies, dass der Vorgang noch ausgeführt wird. Bei true ist der Vorgang abgeschlossen und es ist entweder error oder response verfügbar.

Union- result . Das Operationsergebnis, das entweder ein error oder eine gültige response sein kann. Wenn done == false , wird weder error noch response gesetzt. Wenn done == true , kann genau entweder ein error oder response festgelegt werden. Einige Dienste liefern möglicherweise nicht das Ergebnis. result kann nur eines der folgenden sein:
error

object ( Status )

Das Fehlerergebnis des Vorgangs im Falle eines Fehlers oder Abbruchs.

response

object

Die normale Reaktion der Operation im Erfolgsfall. Wenn die ursprüngliche Methode keine Erfolgsdaten zurückgibt, z. B. Delete , lautet die Antwort google.protobuf.Empty . Wenn die ursprüngliche Methode die Standardmethode Get / Create / Update ist, sollte die Antwort die Ressource sein. Bei anderen Methoden sollte die Antwort den Typ XxxResponse haben, wobei Xxx der ursprüngliche Methodenname ist. Wenn der ursprüngliche Methodenname beispielsweise TakeSnapshot() lautet, ist der abgeleitete Antworttyp TakeSnapshotResponse .

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

Status

Der Status definiert ein logisches Fehlermodell, das für verschiedene Programmierumgebungen geeignet ist, einschließlich REST-APIs und RPC-APIs. Es wird von gRPC verwendet. Jede Status enthält drei Datenelemente: Fehlercode, Fehlermeldung und Fehlerdetails.

Mehr über dieses Fehlermodell und wie man damit arbeitet, erfahren Sie im API Design Guide .

JSON-Darstellung
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Felder
code

integer

Der Statuscode, der ein Enumerationswert von google.rpc.Code sein sollte.

message

string

Eine entwicklerseitige Fehlermeldung, die auf Englisch sein sollte. Jede benutzerseitige Fehlermeldung sollte lokalisiert und im Feld google.rpc.Status.details gesendet oder vom Client lokalisiert werden.

details[]

object

Eine Liste von Nachrichten, die die Fehlerdetails enthalten. Es gibt einen gemeinsamen Satz von Nachrichtentypen, die von APIs verwendet werden können.

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

Methoden

get

 Ruft den neuesten Status eines lang andauernden Vorgangs ab.