REST Resource: sites.versions

Ressource: Version

Eine Version ist eine Konfiguration und eine Sammlung statischer Dateien, die bestimmen, wie eine Site angezeigt wird.

JSON-Darstellung
{
  "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
}
Felder
name

string

Der vollständig qualifizierte Ressourcenname für die Version im Format:

sites/ SITE_ID /versions/ VERSION_ID

Dieser Name wird im Antworttext bereitgestellt, wenn Sie versions.create aufrufen.

status

enum ( VersionStatus )

Der Bereitstellungsstatus der Version.

Für eine erfolgreiche Bereitstellung rufen Sie versions.create auf, um eine neue Version zu erstellen (Status „ CREATED “), laden Sie alle gewünschten Dateien in die Version hoch und aktualisieren Sie die Version dann auf den Status FINALIZED “.

Beachten Sie, dass das System die Version automatisch als ABANDONED markiert, wenn Sie die Version länger als 12 Stunden im Status CREATED belassen.

Sie können den Status einer Version auch in DELETED ändern, indem Sie versions.delete aufrufen.

config

object ( ServingConfig )

Die Konfiguration für das Verhalten der Site. Diese Konfiguration ist in der Datei firebase.json vorhanden.

labels

map (key: string, value: string)

Die Bezeichnungen, die für zusätzliche Metadaten und/oder Filterung verwendet werden.

Ein Objekt, das eine Liste von "key": value Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

createTime

string ( Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Version erstellt wurde.

Ein Zeitstempel im RFC3339 UTC „Zulu“-Format mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z" .

createUser

object ( ActingUser )

Nur Ausgabe. Identifiziert den Benutzer, der die Version erstellt hat.

finalizeTime

string ( Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Version FINALIZED war.

Ein Zeitstempel im RFC3339 UTC „Zulu“-Format mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z" .

finalizeUser

object ( ActingUser )

Nur Ausgabe. Identifiziert den Benutzer, der die Version FINALIZED .

deleteTime

string ( Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Version DELETED wurde.

Ein Zeitstempel im RFC3339 UTC „Zulu“-Format mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z" .

deleteUser

object ( ActingUser )

Nur Ausgabe. Identifiziert den Benutzer, der die Version DELETED .

fileCount

string ( int64 format)

Nur Ausgabe. Die Gesamtzahl der mit der Version verknüpften Dateien.

Dieser Wert wird berechnet, nachdem eine Version FINALIZED ist.

versionBytes

string ( int64 format)

Nur Ausgabe. Die insgesamt gespeicherte Bytegröße der Version.

Dieser Wert wird berechnet, nachdem eine Version FINALIZED ist.

Versionsstatus

Der aktuell bekannte Status einer bestimmten Version im Bereitstellungslebenszyklus.

Aufzählungen
VERSION_STATUS_UNSPECIFIED Der Standardstatus; sollten nicht absichtlich verwendet werden.
CREATED Die Version wurde erstellt und Inhalte werden derzeit zur Version hinzugefügt.
FINALIZED Der gesamte Inhalt wurde zur Version hinzugefügt und die Version kann nicht mehr geändert werden.
DELETED Die Version wurde gelöscht.
ABANDONED Die Version wurde nicht innerhalb von 12 Stunden auf FINALIZED aktualisiert und automatisch gelöscht.
EXPIRED Die Version liegt außerhalb des von der Site konfigurierten Grenzwerts für die Anzahl der beibehaltenen Versionen, daher ist die Löschung des Inhalts der Version geplant.
CLONING Die Version wird von einer anderen Version geklont. Alle Inhalte werden weiterhin kopiert.

ServingConfig

Die Konfiguration, wie eingehende Anfragen an eine Site weitergeleitet und verarbeitet werden sollen, bevor Inhalte bereitgestellt werden. Die URL-Anforderungspfade werden mit den angegebenen URL-Mustern in der Konfiguration abgeglichen, dann wendet Hosting die entsprechende Konfiguration gemäß einer bestimmten Prioritätsreihenfolge an.

JSON-Darstellung
{
  "headers": [
    {
      object (Header)
    }
  ],
  "redirects": [
    {
      object (Redirect)
    }
  ],
  "rewrites": [
    {
      object (Rewrite)
    }
  ],
  "cleanUrls": boolean,
  "trailingSlashBehavior": enum (TrailingSlashBehavior),
  "i18n": {
    object (I18nConfig)
  }
}
Felder
headers[]

object ( Header )

Ein Array von Objekten, wobei jedes Objekt ein URL-Muster angibt, das bei Übereinstimmung mit dem Anforderungs-URL-Pfad Hosting dazu veranlasst, die angegebenen benutzerdefinierten Antwortheader anzuwenden.

redirects[]

object ( Redirect )

Ein Array von Objekten (Umleitungsregeln genannt), wobei jede Regel ein URL-Muster angibt, das bei Übereinstimmung mit dem Anforderungs-URL-Pfad Hosting dazu veranlasst, mit einer Umleitung zum angegebenen Zielpfad zu antworten.

rewrites[]

object ( Rewrite )

Ein Array von Objekten (Rewrite-Regeln genannt), wobei jede Regel ein URL-Muster angibt, das bei Übereinstimmung mit dem Anforderungs-URL-Pfad Hosting dazu veranlasst, zu antworten, als ob dem Dienst die angegebene Ziel-URL gegeben worden wäre.

cleanUrls

boolean

Legt fest, ob die Dateierweiterung aus hochgeladenen Dateien entfernt werden soll.

trailingSlashBehavior

enum ( TrailingSlashBehavior )

Definiert, wie mit einem abschließenden Schrägstrich im URL-Pfad umgegangen wird.

i18n

object ( I18nConfig )

Optional. Definiert das i18n-Rewrite-Verhalten.

Ein Header gibt ein URL-Muster an, das bei Übereinstimmung mit dem Anforderungs-URL-Pfad Hosting dazu veranlasst, die angegebenen benutzerdefinierten Antwortheader anzuwenden.

JSON-Darstellung
{
  "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.
}
Felder
headers

map (key: string, value: string)

Erforderlich. Die zusätzlichen Header, die der Antwort hinzugefügt werden sollen.

Ein Objekt, das eine Liste von "key": value Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

Union- pattern .
Erforderlich. Ein Zeichenfolgen-URL-Muster, das mit dem Anforderungs-URL-Pfad abgeglichen wird, um zu bestimmen, ob dieser benutzerdefinierte Antwortheader angewendet werden soll. Kann entweder ein Glob im Bash-Stil oder ein regulärer RE2-Ausdruck sein.

pattern kann nur eines der folgenden sein:
glob

string

Der vom Benutzer bereitgestellte Glob , der mit dem Anforderungs-URL-Pfad abgeglichen werden soll.

regex

string

Der vom Benutzer bereitgestellte reguläre RE2-Ausdruck, der mit dem Anforderungs-URL-Pfad abgeglichen werden soll.

Umleiten

Eine Redirect gibt ein URL-Muster an, das bei Übereinstimmung mit dem Anforderungs-URL-Pfad Hosting dazu veranlasst, mit einer Umleitung zum angegebenen Zielpfad zu antworten.

JSON-Darstellung
{
  "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.
}
Felder
statusCode

integer

Erforderlich. Der Status-HTTP-Code, der in der Antwort zurückgegeben werden soll. Es muss ein gültiger 3xx-Statuscode sein.

location

string

Erforderlich. Der Wert, der in den HTTP-Location-Header der Antwort eingefügt werden soll.

Der Speicherort kann Erfassungsgruppenwerte aus dem Muster enthalten, wobei ein : -Präfix zur Identifizierung des Segments und ein optionales * zur Erfassung des Rests der URL verwendet werden. Zum Beispiel:

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

Union- pattern .
Erforderlich. Ein Zeichenfolgen-URL-Muster, das mit dem Anforderungs-URL-Pfad abgeglichen wird, um zu bestimmen, ob diese Umleitung angewendet werden soll. Kann entweder ein Glob im Bash-Stil oder ein regulärer RE2-Ausdruck sein.

pattern kann nur eines der folgenden sein:
glob

string

Der vom Benutzer bereitgestellte Glob , der mit dem Anforderungs-URL-Pfad abgeglichen werden soll.

regex

string

Der vom Benutzer bereitgestellte reguläre RE2-Ausdruck, der mit dem Anforderungs-URL-Pfad abgeglichen werden soll.

Umschreiben

Ein Rewrite gibt ein URL-Muster an, das bei Übereinstimmung mit dem Anforderungs-URL-Pfad Hosting dazu veranlasst, so zu reagieren, als ob dem Dienst die angegebene Ziel-URL gegeben worden wäre.

JSON-Darstellung
{
  "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.
}
Felder
functionRegion

string

Optional. Geben Sie eine Cloud-Region für neu geschriebene Funktionsaufrufe an. Wenn nicht angegeben, wird standardmäßig us-central1 verwendet.

Union- pattern .
Erforderlich. Ein Zeichenfolgen-URL-Muster, das mit dem Anforderungs-URL-Pfad abgeglichen wird, um zu bestimmen, ob diese Umschreibung angewendet werden soll. Kann entweder ein Glob im Bash-Stil oder ein regulärer RE2-Ausdruck sein.

pattern kann nur eines der folgenden sein:
glob

string

Der vom Benutzer bereitgestellte Glob , der mit dem Anforderungs-URL-Pfad abgeglichen werden soll.

regex

string

Der vom Benutzer bereitgestellte reguläre RE2-Ausdruck, der mit dem Anforderungs-URL-Pfad abgeglichen werden soll.

behavior im Unionsfeld.
Erforderlich. Das Verhalten des Umschreibens.

behavior kann nur eines der folgenden sein:
path

string

Der URL-Pfad, in den die Anfrage umgeschrieben werden soll.

function

string

Die Funktion, an die Anfragen weitergeleitet werden. Muss genau mit dem exportierten Funktionsnamen übereinstimmen.

run

object ( CloudRunRewrite )

Die Anfrage wird an Cloud Run weitergeleitet.

CloudRunRewrite

Eine konfigurierte Umschreibung, die Anfragen an einen Cloud Run-Dienst weiterleitet. Wenn der Cloud Run-Dienst beim Festlegen oder Aktualisieren Ihrer Firebase Hosting-Konfiguration nicht vorhanden ist, schlägt die Anfrage fehl. Alle Fehler vom Cloud Run-Dienst werden an den Endbenutzer weitergeleitet (wenn Sie beispielsweise einen Dienst löschen, erhalten alle an diesen Dienst gerichteten Anforderungen einen 404 Fehler).

JSON-Darstellung
{
  "serviceId": string,
  "region": string,
  "tag": string
}
Felder
serviceId

string

Erforderlich. Benutzerdefinierte ID des Cloud Run-Dienstes.

region

string

Optional. Vom Benutzer bereitgestellte Region, in der der Cloud Run-Dienst gehostet wird.

Der Standardwert ist us-central1 wenn nicht angegeben.

tag

string

Optional. Vom Benutzer bereitgestelltes TrafficConfig-Tag, an das Datenverkehr gesendet werden soll.

Wenn es weggelassen wird, wird der Datenverkehr an den dienstweiten URI gesendet

TrailingSlashBehavior

Definiert, ob ein abschließender Schrägstrich zum Anforderungs-URL-Pfad hinzugefügt oder daraus entfernt werden soll.

Aufzählungen
TRAILING_SLASH_BEHAVIOR_UNSPECIFIED

Es ist kein Verhalten angegeben.

Dateien werden nur an ihrem genauen Speicherort bereitgestellt und abschließende Schrägstriche werden nur zu Verzeichnisindizes hinzugefügt.

ADD Nachgestellte Schrägstriche werden zu Verzeichnisindizes sowie zu allen URL-Pfaden hinzugefügt , die nicht mit einer Dateierweiterung enden.
REMOVE Nachgestellte Schrägstriche werden aus Verzeichnisindizes sowie aus allen URL-Pfaden entfernt , die nicht mit einer Dateierweiterung enden.

I18nConfig

Sofern vorhanden, sind i18n-Umschreibungen aktiviert.

JSON-Darstellung
{
  "root": string
}
Felder
root

string

Erforderlich. Der vom Benutzer angegebene Pfad, in dem im öffentlichen Verzeichnis nach länder- und sprachspezifischen Inhalten gesucht wird.

Methoden

clone

 Erstellt eine neue Version auf der angegebenen Zielsite unter Verwendung des Inhalts der angegebenen Version.

create

 Erstellt eine neue Version für die angegebene Site.

delete

 Löscht die angegebene Version.

get

 Rufen Sie die angegebene Version ab, die für die angegebene Site erstellt wurde.

list

 Listet die Versionen auf, die für die angegebene Site erstellt wurden.

patch

 Aktualisiert die angegebenen Metadaten für die angegebene Version.

populateFiles

 Fügt Inhaltsdateien zur angegebenen Version hinzu.