REST Resource: sites.versions

Ressource : Version

Une Version est une configuration et une collection de fichiers statiques qui déterminent la manière dont un site est affiché.

Représentation JSON
{
  "name": string,
  "status": enum (VersionStatus),
  "config": {
    object (ServingConfig)
  },
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "createUser": {
    object (ActingUser)
  },
  "finalizeTime": string,
  "finalizeUser": {
    object (ActingUser)
  },
  "deleteTime": string,
  "deleteUser": {
    object (ActingUser)
  },
  "fileCount": string,
  "versionBytes": string
}
Des champs
name

string

Le nom complet de la ressource pour la version, au format :

sites/ SITE_ID /versions/ VERSION_ID

Ce nom est fourni dans le corps de la réponse lorsque vous appelez versions.create .

status

enum ( VersionStatus )

L'état de déploiement de la version.

Pour un déploiement réussi, appelez versions.create pour créer une nouvelle version (statut CREATED ), téléchargez tous les fichiers souhaités dans la version, puis mettez à jour la version vers le statut FINALIZED .

Notez que si vous laissez la version dans l'état CREATED pendant plus de 12 heures, le système marquera automatiquement la version comme ABANDONED .

Vous pouvez également modifier le statut d'une version en DELETED en appelant versions.delete .

config

object ( ServingConfig )

La configuration du comportement du site. Cette configuration existe dans le fichier firebase.json .

labels

map (key: string, value: string)

Les étiquettes utilisées pour les métadonnées supplémentaires et/ou le filtrage.

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

createTime

string ( Timestamp format)

Sortie uniquement. Heure à laquelle la version 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" .

createUser

object ( ActingUser )

Sortie uniquement. Identifie l'utilisateur qui a créé la version.

finalizeTime

string ( Timestamp format)

Sortie uniquement. L'heure à laquelle la version a été FINALIZED .

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" .

finalizeUser

object ( ActingUser )

Sortie uniquement. Identifie l'utilisateur qui FINALIZED la version.

deleteTime

string ( Timestamp format)

Sortie uniquement. L'heure à laquelle la version a été DELETED .

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" .

deleteUser

object ( ActingUser )

Sortie uniquement. Identifie l'utilisateur qui DELETED la version.

fileCount

string ( int64 format)

Sortie uniquement. Le nombre total de fichiers associés à la version.

Cette valeur est calculée une fois qu'une version est FINALIZED .

versionBytes

string ( int64 format)

Sortie uniquement. La taille totale en octets stockés de la version.

Cette valeur est calculée une fois qu'une version est FINALIZED .

État de la version

L'état actuel connu d'une version spécifique dans le cycle de vie de déploiement.

Énumérations
VERSION_STATUS_UNSPECIFIED Le statut par défaut ; ne doit pas être utilisé intentionnellement.
CREATED La version a été créée et du contenu est en cours d'ajout à la version.
FINALIZED Tout le contenu a été ajouté à la version et la version ne peut plus être modifiée.
DELETED La version a été supprimée.
ABANDONED La version n'a pas été mise à jour vers FINALIZED dans les 12 heures et a été automatiquement supprimée.
EXPIRED La version se situe en dehors de la limite configurée par le site pour le nombre de versions conservées. La suppression du contenu de la version est donc planifiée.
CLONING La version est clonée à partir d'une autre version. Tout le contenu est toujours copié.

ServiceConfig

Configuration de la manière dont les requêtes entrantes vers un site doivent être acheminées et traitées avant de diffuser le contenu. Les chemins de requête d'URL sont comparés aux modèles d'URL spécifiés dans la configuration, puis l'hébergement applique la configuration applicable selon un ordre de priorité spécifique.

Représentation JSON
{
  "headers": [
    {
      object (Header)
    }
  ],
  "redirects": [
    {
      object (Redirect)
    }
  ],
  "rewrites": [
    {
      object (Rewrite)
    }
  ],
  "cleanUrls": boolean,
  "trailingSlashBehavior": enum (TrailingSlashBehavior),
  "i18n": {
    object (I18nConfig)
  }
}
Des champs
headers[]

object ( Header )

Tableau d'objets, où chaque objet spécifie un modèle d'URL qui, s'il correspond au chemin d'URL de la demande, déclenche l'application par Hosting des en-têtes de réponse personnalisés spécifiés.

redirects[]

object ( Redirect )

Un tableau d'objets (appelés règles de redirection), où chaque règle spécifie un modèle d'URL qui, s'il correspond au chemin d'URL de la demande, déclenche la réponse de l'hébergement par une redirection vers le chemin de destination spécifié.

rewrites[]

object ( Rewrite )

Un tableau d'objets (appelés règles de réécriture), où chaque règle spécifie un modèle d'URL qui, s'il correspond au chemin de l'URL de la demande, déclenche la réponse de l'hébergement comme si le service recevait l'URL de destination spécifiée.

cleanUrls

boolean

Définit s'il faut supprimer l'extension de fichier des fichiers téléchargés.

trailingSlashBehavior

enum ( TrailingSlashBehavior )

Définit comment gérer une barre oblique finale dans le chemin de l'URL.

i18n

object ( I18nConfig )

Facultatif. Définit le comportement de réécriture d'i18n.

Un Header spécifie un modèle d'URL qui, s'il correspond au chemin de l'URL de la demande, déclenche l'hébergement pour appliquer les en-têtes de réponse personnalisés spécifiés.

Représentation JSON
{
  "headers": {
    string: string,
    ...
  },

  // Union field pattern can be only one of the following:
  "glob": string,
  "regex": string
  // End of list of possible types for union field pattern.
}
Des champs
headers

map (key: string, value: string)

Requis. En-têtes supplémentaires à ajouter à la réponse.

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

pattern de champ d'union.
Requis. Un modèle d'URL de chaîne à comparer au chemin d'URL de la demande pour déterminer s'il convient d'appliquer cet en-tête de réponse personnalisé. Peut être soit un glob de style Bash, soit une expression régulière RE2.

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

string

Le glob fourni par l'utilisateur à comparer au chemin de l'URL de la demande.

regex

string

Expression régulière RE2 fournie par l'utilisateur à comparer au chemin de l'URL de la demande.

Réorienter

Une Redirect spécifie un modèle d'URL qui, s'il correspond au chemin d'URL de la demande, déclenche la réponse de l'hébergement par une redirection vers le chemin de destination spécifié.

Représentation JSON
{
  "statusCode": integer,
  "location": string,

  // Union field pattern can be only one of the following:
  "glob": string,
  "regex": string
  // End of list of possible types for union field pattern.
}
Des champs
statusCode

integer

Requis. Le code HTTP d'état à renvoyer dans la réponse. Il doit s'agir d'un code d'état 3xx valide.

location

string

Requis. La valeur à mettre dans l'en-tête d'emplacement HTTP de la réponse.

L'emplacement peut contenir des valeurs de groupe de capture à partir du modèle en utilisant un préfixe : pour identifier le segment et un * facultatif pour capturer le reste de l'URL. Par exemple:

"glob": "/:capture*",
"statusCode": 301,
"location": "https://example.com/foo/:capture"

pattern de champ d'union.
Requis. Un modèle d'URL de chaîne à comparer au chemin d'URL de la demande pour déterminer s'il faut appliquer cette redirection. Peut être soit un glob de style Bash, soit une expression régulière RE2.

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

string

Le glob fourni par l'utilisateur à comparer au chemin de l'URL de la demande.

regex

string

Expression régulière RE2 fournie par l'utilisateur à comparer au chemin de l'URL de la demande.

Récrire

Une Rewrite spécifie un modèle d'URL qui, s'il correspond au chemin de l'URL de la demande, déclenche la réponse de l'hébergement comme si le service recevait l'URL de destination spécifiée.

Représentation JSON
{
  "functionRegion": string,

  // Union field pattern can be only one of the following:
  "glob": string,
  "regex": string
  // End of list of possible types for union field pattern.

  // Union field behavior can be only one of the following:
  "path": string,
  "function": string,
  "run": {
    object (CloudRunRewrite)
  }
  // End of list of possible types for union field behavior.
}
Des champs
functionRegion

string

Facultatif. Spécifiez une région Cloud pour les appels de fonctions réécrites. S’il n’est pas fourni, la valeur par défaut est us-central1.

pattern de champ d'union.
Requis. Un modèle d'URL de chaîne à comparer au chemin d'URL de la demande pour déterminer s'il faut appliquer cette réécriture. Peut être soit un glob de style Bash, soit une expression régulière RE2.

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

string

Le glob fourni par l'utilisateur à comparer au chemin de l'URL de la demande.

regex

string

Expression régulière RE2 fournie par l'utilisateur à comparer au chemin de l'URL de la demande.

behavior sur le terrain syndical.
Requis. Le comportement de la réécriture.

behavior ne peut être que l’un des suivants :
path

string

Le chemin de l'URL vers lequel réécrire la demande.

function

string

La fonction vers laquelle envoyer des requêtes par proxy. Doit correspondre exactement au nom de la fonction exportée.

run

object ( CloudRunRewrite )

La demande sera transmise à Cloud Run.

CloudRunRewrite

Une réécriture configurée qui dirige les requêtes vers un service Cloud Run. Si le service Cloud Run n'existe pas lors de la définition ou de la mise à jour de votre configuration d'hébergement Firebase, la demande échoue. Toutes les erreurs du service Cloud Run sont transmises à l'utilisateur final (par exemple, si vous supprimez un service, toutes les demandes adressées à ce service reçoivent une erreur 404 ).

Représentation JSON
{
  "serviceId": string,
  "region": string,
  "tag": string
}
Des champs
serviceId

string

Requis. ID défini par l'utilisateur du service Cloud Run.

region

string

Facultatif. Région fournie par l'utilisateur où le service Cloud Run est hébergé.

La valeur par défaut est us-central1 s'il n'est pas fourni.

tag

string

Facultatif. Balise TrafficConfig fournie par l'utilisateur vers laquelle envoyer le trafic.

En cas d'omission, le trafic est envoyé à l'URI à l'échelle du service

ComportementTrailingSlash

Définit si une barre oblique finale doit être ajoutée ou supprimée du chemin de l'URL de la demande.

Énumérations
TRAILING_SLASH_BEHAVIOR_UNSPECIFIED

Aucun comportement n'est spécifié.

Les fichiers sont servis uniquement à leur emplacement exact et les barres obliques finales sont uniquement ajoutées aux index de répertoire.

ADD Des barres obliques finales sont ajoutées aux index de répertoire ainsi qu'à tout chemin d'URL ne se terminant pas par une extension de fichier.
REMOVE Les barres obliques finales sont supprimées des index de répertoire ainsi que de tout chemin d'URL ne se terminant pas par une extension de fichier.

I18nConfig

Si elles sont fournies, les réécritures i18n sont activées.

Représentation JSON
{
  "root": string
}
Des champs
root

string

Requis. Le chemin fourni par l'utilisateur où le contenu spécifique au pays et à la langue sera recherché dans le répertoire public.

Méthodes

clone

 Crée une nouvelle version sur le site cible spécifié en utilisant le contenu de la version spécifiée.

create

 Crée une nouvelle version pour le site spécifié.

delete

 Supprime la version spécifiée.

get

 Obtenez la version spécifiée qui a été créée pour le site spécifié.

list

 Répertorie les versions qui ont été créées pour le site spécifié.

patch

 Met à jour les métadonnées spécifiées pour la version spécifiée.

populateFiles

 Ajoute des fichiers de contenu à la version spécifiée.