REST Resource: channels

Recurso: Canal

Un canal de notificaciones que se usa para supervisar cambios en los recursos

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

boolean

Un valor booleano para indicar si se desea la carga útil. Opcional.

id

string

Un UUID o una string única similar que identifica este canal.

resourceId

string

Es un ID opaco que identifica el recurso que se mira 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 visto.

token

string

Una string arbitraria que se envía 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 del vencimiento del canal de notificaciones, expresada como una marca de tiempo de Unix, en milisegundos. Opcional.

type

string

Es el tipo de mecanismo de entrega que se usa en este canal.

address

string

La dirección en la que se entregan las notificaciones de este canal.

params

map (key: string, value: string)

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" }.

kind

string

Identifica esto como un canal de notificaciones que se usa para supervisar cambios en un recurso, que es api#channel.

Métodos

stop

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