REST Resource: channels

Ressource: Kanal

Ein Benachrichtigungskanal, der zum Beobachten von Ressourcenänderungen verwendet wird.

JSON-Darstellung
{
  "payload": boolean,
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "params": {
    string: string,
    ...
  },
  "kind": string
}
Felder
payload

boolean

Ein boolescher Wert, der angibt, ob die Nutzlast benötigt wird. Optional.

id

string

Eine UUID oder ein ähnlicher eindeutiger String, die diesen Kanal identifiziert.

resourceId

string

Eine verschlüsselte ID, die die beobachtete Ressource auf diesem Kanal identifiziert. Stabile Versionen verschiedener API-Versionen.

resourceUri

string

Eine versionsspezifische Kennung für die beobachtete Ressource.

token

string

Ein beliebiger String, der an die Zieladresse gesendet wird, wobei jede Benachrichtigung über diesen Kanal gesendet wird. Optional.

expiration

string (int64 format)

Datum und Uhrzeit des Ablaufs des Benachrichtigungskanals, ausgedrückt als Unix-Zeitstempel, in Millisekunden. Optional.

type

string

Die Art des Auslieferungsmechanismus für diesen Kanal.

address

string

Die Adresse, an die Benachrichtigungen für diesen Kanal gesendet werden.

params

map (key: string, value: string)

Zusätzliche Parameter, die das Verhalten des Bereitstellungskanals steuern. Optional.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

kind

string

Erkennt dies als Benachrichtigungskanal, über den Änderungen an einer Ressource beobachtet werden: api#channel.

Methoden

stop

Beendet die Wiedergabe von Ressourcen über diesen Kanal.