REST Resource: channels
Ресурс: Канал
Канал уведомлений, используемый для отслеживания изменений ресурсов.
JSON-представление |
---|
{
"payload": boolean,
"id": string,
"resourceId": string,
"resourceUri": string,
"token": string,
"expiration": string,
"type": string,
"address": string,
"params": {
string: string,
...
},
"kind": string
} |
Поля |
---|
payload | boolean Логическое значение, указывающее, требуется ли полезная нагрузка. Необязательный. |
id | string UUID или аналогичная уникальная строка, идентифицирующая этот канал. |
resourceId | string Непрозрачный идентификатор, идентифицирующий ресурс, просматриваемый на этом канале. Стабильно в разных версиях API. |
resourceUri | string Идентификатор версии отслеживаемого ресурса. |
token | string Произвольная строка, доставляемая на целевой адрес с каждым уведомлением, доставляемым по этому каналу. Необязательный. |
expiration | string ( int64 format) Дата и время истечения срока действия канала уведомлений, выраженные в виде метки времени Unix, в миллисекундах. Необязательный. |
type | string Тип механизма доставки, используемый для этого канала. Допустимые значения: «web_hook» или «webhook». |
address | string Адрес, по которому доставляются уведомления для этого канала. |
params | map (key: string, value: string) Дополнительные параметры, управляющие поведением канала доставки. Необязательный. Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } . |
kind | string Идентифицирует это как канал уведомлений, используемый для отслеживания изменений в ресурсе api#channel . |
Методы |
---|
| Перестает смотреть ресурсы через этот канал. |
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-01-08 UTC.
[null,null,["Последнее обновление: 2025-01-08 UTC."],[[["A Channel is a notification system used to monitor resource changes, delivering updates to a specified address."],["Channels are configured with parameters like `id`, `type`, `address`, and `payload`, enabling customized notification delivery."],["The `stop` method can be used to halt resource monitoring through a specific channel."],["Channel information is structured in JSON format, including details like resource ID, URI, token, and expiration."]]],["A notification channel (`Channel`) monitors resource changes. It's represented in JSON with fields like `id` (unique identifier), `resourceId` (resource ID being watched), `resourceUri` (version-specific resource ID), `type` (delivery mechanism, e.g., \"web_hook\"), and `address` (notification destination). Optional fields include `payload` (indicates payload requirement), `token` (arbitrary string for notifications), `expiration` (channel's expiration time), and `params` (extra delivery parameters). The `stop` method terminates resource monitoring.\n"]]