REST Resource: channels

Recurso: Canal

Es un canal de notificación que se usa para supervisar los cambios en los recursos.

Representación JSON
{
  "params": {
    string: string,
    ...
  },
  "payload": boolean,
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "kind": string
}
Campos
params

map (key: string, value: string)

Son parámetros adicionales que controlan el comportamiento del canal de entrega. Opcional.

Es un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

payload

boolean

Es un valor booleano que indica si se desea la carga útil. Opcional.

id

string

Es un UUID o una cadena única similar que identifica este canal.

resourceId

string

Es un ID opaco que identifica el recurso que se observa en este canal. Es estable en diferentes versiones de la API.

resourceUri

string

Es un identificador específico de la versión para el recurso observado.

token

string

Es una cadena arbitraria que se entrega a la dirección de destino con cada notificación que se envía a través de este canal. Opcional.

expiration

string (int64 format)

Fecha y hora de vencimiento del canal de notificación, expresadas como una marca de tiempo de Unix en milisegundos. Opcional.

type

string

Es el tipo de mecanismo de entrega que se usa para este canal. Los valores válidos son "web_hook" o "webhook".

address

string

Es la dirección a la que se envían las notificaciones de este canal.

kind

string

Identifica este elemento como un canal de notificación que se usa para supervisar los cambios en un recurso, que es api#channel.

Métodos

stop

Deja de mirar recursos a través de este canal.