REST Resource: sites.channels

Recurso: canal

Um Channel representa um fluxo de lançamentos de um site. Todos os sites têm um canal live padrão que veicula conteúdo para os subdomínios fornecidos pelo Firebase e todos os domínios personalizados conectados.

Representação 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.
}
Campos
name

string

O nome de recurso totalmente qualificado para o canal, no formato:

sites/SITE_ID/channels/CHANNEL_ID
url

string

Apenas saída. O URL em que o conteúdo da versão atual deste canal pode ser visualizado. Esse URL é um subdomínio do site web.app fornecido pelo Firebase.

O conteúdo da versão atual deste canal também pode ser acessado no subdomínio de firebaseapp.com fornecido pelo Firebase.

Se este canal for o canal live para o site de hospedagem, o conteúdo da versão atual desse canal também poderá ser visualizado em todos os domínios personalizados conectados.
release

object (Release)

Apenas saída. A versão atual do canal, se houver.
createTime

string (Timestamp format)

Apenas saída. A hora em que o canal foi criado.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Apenas saída. A hora em que o canal foi atualizado pela última vez.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
retainedReleaseCount

integer

O número de lançamentos anteriores que serão retidos no canal para reversão ou outros fins.

Precisa ser um número de 1 a 100. O padrão é 10 para novos canais.
labels

map (key: string, value: string)

Rótulos de texto usados para metadados e/ou filtragem extras.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Campo de união expiration.

expiration pode ser apenas de um dos tipos a seguir:
expireTime

string (Timestamp format)

O horário em que o canal será excluído automaticamente.

Se for nulo, o canal não será excluído automaticamente. Este campo está presente na saída, seja definido diretamente ou pelo campo ttl.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
ttl

string (Duration format)

Somente entrada. Time to live (TTL) para este canal. Define expireTime como a duração fornecida após o horário da solicitação.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

Métodos

create

 Cria um novo canal no site especificado.

delete

 Exclui o canal especificado do site especificado.

get

 Recupera informações para o canal especificado do site especificado.

list

 Lista os canais do site especificado.

patch

 Atualiza informações para o canal especificado do site especificado.