REST Resource: channels

Recurso: Canal

Canal de notificación que se usa para observar cambios de 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 una carga útil. Opcional.

id

string

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

resourceId

string

Es un ID opaco que identifica el recurso que se está viendo en este canal. Es estable en diferentes versiones de API.

resourceUri

string

Un identificador específico de la versión para el recurso visto.

token

string

Una cadena arbitraria entregada a la dirección de destino con cada notificación entregada a través de este canal. Opcional.

expiration

string (int64 format)

Fecha y hora de 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 utilizado para este canal. Los valores válidos son “web_hook” o “webhook”.

address

string

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

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

kind

string

Lo identifica como un canal de notificaciones que se usa para observar cambios en un recurso, que es api#channel.

Métodos

stop

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