REST Resource: sites.channels

Ressource : Chaîne

Une Channel représente un flux de versions pour un site. Tous les sites disposent d'une chaîne live par défaut qui diffuse du contenu vers les sous-domaines fournis par Firebase et tous les domaines personnalisés connectés.

Représentation 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.
}
Des champs
name

string

Nom de ressource complet pour le canal, au format :

sites/ SITE_ID /channels/ CHANNEL_ID

url

string

Sortie uniquement. L'URL à laquelle le contenu de la version actuelle de cette chaîne peut être consulté. Cette URL est un sous-domaine de web.app fourni par Firebase.

Le contenu de la version actuelle de cette chaîne peut également être consulté sur le sous-domaine fourni par Firebase sur firebaseapp.com .

Si cette chaîne est la chaîne live du site d'hébergement, le contenu de la version actuelle de cette chaîne peut également être consulté sur n'importe quel domaine personnalisé connecté.

release

object ( Release )

Sortie uniquement. La version actuelle de la chaîne, le cas échéant.

createTime

string ( Timestamp format)

Sortie uniquement. L'heure à laquelle la chaîne a été créée.

Un horodatage au format RFC3339 UTC "Zulu", avec une résolution en nanosecondes et jusqu'à neuf chiffres fractionnaires. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z" .

updateTime

string ( Timestamp format)

Sortie uniquement. L'heure à laquelle la chaîne a été mise à jour pour la dernière fois.

Un horodatage au format RFC3339 UTC "Zulu", avec une résolution en nanosecondes et jusqu'à neuf chiffres fractionnaires. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z" .

retainedReleaseCount

integer

Nombre de versions précédentes à conserver sur le canal à des fins de restauration ou à d'autres fins.

Il doit s'agir d'un nombre compris entre 1 et 100. La valeur par défaut est 10 pour les nouvelles chaînes.

labels

map (key: string, value: string)

Étiquettes de texte utilisées pour des métadonnées supplémentaires et/ou un filtrage.

Un objet contenant une liste de paires "key": value . Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" } .

expiration du champ Union.

expiration ne peut être que l'un des éléments suivants :

expireTime

string ( Timestamp format)

L'heure à laquelle la chaîne sera automatiquement supprimée.

Si nul, la chaîne ne sera pas automatiquement supprimée. Ce champ est présent dans la sortie qu'il soit défini directement ou via le champ ttl .

Un horodatage au format RFC3339 UTC "Zulu", avec une résolution en nanosecondes et jusqu'à neuf chiffres fractionnaires. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z" .

ttl

string ( Duration format)

Entrée uniquement. Un temps à vivre pour cette chaîne. Définit expireTime sur la durée fournie après l’heure de la demande.

Une durée en secondes avec jusqu'à neuf chiffres fractionnaires, se terminant par « s ». Exemple : "3.5s" .

Méthodes

create

 Crée un nouveau canal dans le site spécifié.

delete

 Supprime le canal spécifié du site spécifié.

get

 Récupère des informations pour le canal spécifié du site spécifié.

list

 Répertorie les chaînes du site spécifié.

patch

 Met à jour les informations pour le canal spécifié du site spécifié.