REST Resource: sites.channels

Ресурс: Канал

Channel представляет собой поток выпусков для сайта. На всех сайтах есть live канал по умолчанию, который передает контент на поддомены, предоставленные Firebase, и любые подключенные пользовательские домены.

JSON-представление
{
  "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.
}
Поля
name

string

Полное имя ресурса для канала в формате:

sites/ SITE_ID /channels/ CHANNEL_ID

url

string

Только вывод. URL-адрес, по которому можно просмотреть содержимое текущего выпуска этого канала. Этот URL-адрес является субдоменом web.app , предоставленным Firebase.

Содержимое текущей версии этого канала также можно просмотреть на поддомене firebaseapp.com , предоставленном Firebase.

Если этот канал является live каналом хостинг-сайта, то содержимое текущей версии этого канала также можно просмотреть на любых подключенных пользовательских доменах.

release

object ( Release )

Только вывод. Текущий выпуск канала, если таковой имеется.

createTime

string ( Timestamp format)

Только вывод. Время создания канала.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

updateTime

string ( Timestamp format)

Только вывод. Время последнего обновления канала.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

retainedReleaseCount

integer

Количество предыдущих выпусков, которые необходимо сохранить на канале для отката или других целей.

Должно быть число от 1 до 100. По умолчанию 10 для новых каналов.

labels

map (key: string, value: string)

Текстовые метки, используемые для дополнительных метаданных и/или фильтрации.

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

expiration поля объединения .

expiration может быть только одним из следующих:

expireTime

string ( Timestamp format)

Время, в которое канал будет автоматически удален.

Если значение равно нулю, канал не будет автоматически удален. Это поле присутствует в выводе независимо от того, установлено ли оно напрямую или через поле ttl .

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

ttl

string ( Duration format)

Только ввод. Время жить для этого канала. Устанавливает expireTime на указанную продолжительность после времени запроса.

Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

Методы

create

 Создает новый канал на указанном сайте.

delete

 Удаляет указанный канал указанного сайта.

get

 Получает информацию для указанного канала указанного сайта.

list

 Перечисляет каналы для указанного сайта.

patch

 Обновляет информацию для указанного канала указанного сайта.