REST Resource: sites.channels

Resource: Channel

AChannel represents a stream of releases for a site. All sites have a defaultlive 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 fieldexpiration can be only one of the following:"expireTime":string,"ttl":string// End of list of possible types for union fieldexpiration.}
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 ofweb.app.

The content of this channel's current release can also be viewed at the Firebase-provided subdomain offirebaseapp.com.

If this channel is thelive 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 fieldexpiration.

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 thettl 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. SetsexpireTime 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

create

 Creates a new channel in the specified site.

delete

 Deletes the specified channel of the specified site.

get

 Retrieves information for the specified channel of the specified site.

list

 Lists the channels for the specified site.

patch

 Updates information for the specified channel of the specified site.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2023-09-11 UTC.