REST Resource: sites.channels
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Channel
A Channel represents a stream of releases for a site. All sites have a default live channel that serves content to the Firebase-provided subdomains and any connected custom domains.
| JSON representation |
{
"name": string,
"url": string,
"release": {
object (Release)
},
"createTime": string,
"updateTime": string,
"retainedReleaseCount": integer,
"labels": {
string: string,
...
},
// Union field expiration can be only one of the following:
"expireTime": string,
"ttl": string
// End of list of possible types for union field expiration.
} |
| Fields |
name |
string
The fully-qualified resource name for the channel, in the format:
sites/SITE_ID/channels/CHANNEL_ID
|
url |
string
Output only. The URL at which the content of this channel's current release can be viewed. This URL is a Firebase-provided subdomain of web.app. The content of this channel's current release can also be viewed at the Firebase-provided subdomain of firebaseapp.com. If this channel is the live channel for the Hosting site, then the content of this channel's current release can also be viewed at any connected custom domains.
|
release |
object (Release)
Output only. The current release for the channel, if any.
|
createTime |
string (Timestamp format)
Output only. The time at which the channel was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
|
updateTime |
string (Timestamp format)
Output only. The time at which the channel was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
|
retainedReleaseCount |
integer
The number of previous releases to retain on the channel for rollback or other purposes. Must be a number between 1-100. Defaults to 10 for new channels.
|
labels |
map (key: string, value: string)
Text labels used for extra metadata and/or filtering. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
|
Union field expiration. expiration can be only one of the following:
|
expireTime |
string (Timestamp format)
The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in the output whether it's set directly or via the ttl field. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
|
ttl |
string (Duration format)
Input only. A time-to-live for this channel. Sets expireTime to the provided duration past the time of the request. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
|
Methods |
|
|
Creates a new channel in the specified site. |
|
|
Deletes the specified channel of the specified site. |
|
|
Retrieves information for the specified channel of the specified site. |
|
|
Lists the channels for the specified site. |
|
|
Updates information for the specified channel of the specified site. |
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 2023-09-11 UTC.
[null,null,["Last updated 2023-09-11 UTC."],[],[],null,["# REST Resource: sites.channels\n\nResource: Channel\n-----------------\n\nA `Channel` represents a stream of releases for a site. All sites have a default `live` channel that serves content to the Firebase-provided subdomains and any connected custom domains.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"url\": string, \"release\": { object (/docs/reference/hosting/rest/v1beta1/sites.channels.releases#Release) }, \"createTime\": string, \"updateTime\": string, \"retainedReleaseCount\": integer, \"labels\": { string: string, ... }, // Union field `expiration` can be only one of the following: \"expireTime\": string, \"ttl\": string // End of list of possible types for union field `expiration`. } ``` |\n\n| Fields ||\n|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The fully-qualified resource name for the channel, in the format: `sites/`\u003cvar translate=\"no\"\u003eSITE_ID\u003c/var\u003e`/channels/`\u003cvar translate=\"no\"\u003eCHANNEL_ID\u003c/var\u003e |\n| `url` | `string` Output only. The URL at which the content of this channel's current release can be viewed. This URL is a Firebase-provided subdomain of `web.app`. The content of this channel's current release can also be viewed at the Firebase-provided subdomain of `firebaseapp.com`. If this channel is the `live` channel for the Hosting site, then the content of this channel's current release can also be viewed at any connected custom domains. |\n| `release` | `object (`[Release](/docs/reference/hosting/rest/v1beta1/sites.channels.releases#Release)`)` Output only. The current release for the channel, if any. |\n| `createTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp)` format)` Output only. The time at which the channel was created. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: `\"2014-10-02T15:01:23Z\"` and `\"2014-10-02T15:01:23.045123456Z\"`. |\n| `updateTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp)` format)` Output only. The time at which the channel was last updated. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: `\"2014-10-02T15:01:23Z\"` and `\"2014-10-02T15:01:23.045123456Z\"`. |\n| `retainedReleaseCount` | `integer` The number of previous releases to retain on the channel for rollback or other purposes. Must be a number between 1-100. Defaults to 10 for new channels. |\n| `labels` | `map (key: string, value: string)` Text labels used for extra metadata and/or filtering. An object containing a list of `\"key\": value` pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`. |\n| Union field `expiration`. `expiration` can be only one of the following: ||\n| `expireTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp)` format)` The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in the output whether it's set directly or via the `ttl` field. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: `\"2014-10-02T15:01:23Z\"` and `\"2014-10-02T15:01:23.045123456Z\"`. |\n| `ttl` | `string (`[Duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration)` format)` Input only. A time-to-live for this channel. Sets `expireTime` to the provided duration past the time of the request. A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `\"3.5s\"`. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------|------------------------------------------------------------------------|\n| ### [create](/docs/reference/hosting/rest/v1beta1/sites.channels/create) | Creates a new channel in the specified site. |\n| ### [delete](/docs/reference/hosting/rest/v1beta1/sites.channels/delete) | Deletes the specified channel of the specified site. |\n| ### [get](/docs/reference/hosting/rest/v1beta1/sites.channels/get) | Retrieves information for the specified channel of the specified site. |\n| ### [list](/docs/reference/hosting/rest/v1beta1/sites.channels/list) | Lists the channels for the specified site. |\n| ### [patch](/docs/reference/hosting/rest/v1beta1/sites.channels/patch) | Updates information for the specified channel of the specified site. |"]]
