SubscriptionChannel
Stay organized with collections
Save and categorize content based on your preferences.
An notification channel used to watch for resource changes.
JSON representation |
{
"id": string,
"token": string,
"expiration": string,
"type": string,
"address": string,
"payload": boolean,
"params": {
string: string,
...
},
"resourceId": string,
"resourceUri": string,
"kind": string
} |
Fields |
id |
string
A UUID or similar unique string that identifies this channel.
|
token |
string
An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
|
expiration |
string (int64 format)
Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
|
type |
string
The type of delivery mechanism used for this channel.
|
address |
string
The address where notifications are delivered for this channel.
|
payload |
boolean
A Boolean value to indicate whether payload is wanted. Optional.
|
params |
map (key: string, value: string)
Additional parameters controlling delivery channel behavior. Optional. For example, params.ttl specifies the time-to-live in seconds for the notification channel, where the default is 2 hours and the maximum TTL is 2 days. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .
|
resourceId |
string
An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
|
resourceUri |
string
A version-specific identifier for the watched resource.
|
kind |
string
Identifies this as a notification channel used to watch for changes to a resource, which is api#channel .
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-25 UTC.
[null,null,["Last updated 2025-03-25 UTC."],[],[],null,["# SubscriptionChannel\n\nAn notification channel used to watch for resource changes.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"token\": string, \"expiration\": string, \"type\": string, \"address\": string, \"payload\": boolean, \"params\": { string: string, ... }, \"resourceId\": string, \"resourceUri\": string, \"kind\": string } ``` |\n\n| Fields ||\n|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` A UUID or similar unique string that identifies this channel. |\n| `token` | `string` An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. |\n| `expiration` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. |\n| `type` | `string` The type of delivery mechanism used for this channel. |\n| `address` | `string` The address where notifications are delivered for this channel. |\n| `payload` | `boolean` A Boolean value to indicate whether payload is wanted. Optional. |\n| `params` | `map (key: string, value: string)` Additional parameters controlling delivery channel behavior. Optional. For example, `params.ttl` specifies the time-to-live in seconds for the notification channel, where the default is 2 hours and the maximum TTL is 2 days. An object containing a list of `\"key\": value` pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`. |\n| `resourceId` | `string` An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. |\n| `resourceUri` | `string` A version-specific identifier for the watched resource. |\n| `kind` | `string` Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`. |"]]