REST Resource: sites.versions

Risorsa: versione

Una Version è una configurazione e una raccolta di file statici che determinano il modo in cui viene visualizzato un sito.

Rappresentazione 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
}
Campi
name

string

Il nome completo della risorsa per la versione, nel formato:

sites/ SITE_ID /versions/ VERSION_ID

Questo nome viene fornito nel corpo della risposta quando chiami versions.create .

status

enum ( VersionStatus )

Lo stato di distribuzione della versione.

Per una distribuzione riuscita, chiama versions.create per creare una nuova versione (stato CREATED ), carica tutti i file desiderati nella versione, quindi aggiorna la versione allo stato FINALIZED .

Tieni presente che se lasci la versione nello stato CREATED per più di 12 ore, il sistema contrassegnerà automaticamente la versione come ABANDONED .

Puoi anche modificare lo stato di una versione in DELETED chiamando versions.delete .

config

object ( ServingConfig )

La configurazione per il comportamento del sito. Questa configurazione esiste nel file firebase.json .

labels

map (key: string, value: string)

Le etichette utilizzate per metadati aggiuntivi e/o filtri.

Un oggetto contenente un elenco di coppie "key": value . Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

createTime

string ( Timestamp format)

Solo uscita. L'ora in cui è stata creata la versione.

Un timestamp in formato RFC3339 UTC "Zulu", con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z" .

createUser

object ( ActingUser )

Solo uscita. Identifica l'utente che ha creato la versione.

finalizeTime

string ( Timestamp format)

Solo uscita. L'ora in cui la versione è stata FINALIZED .

Un timestamp in formato RFC3339 UTC "Zulu", con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z" .

finalizeUser

object ( ActingUser )

Solo uscita. Identifica l'utente che FINALIZED la versione.

deleteTime

string ( Timestamp format)

Solo uscita. L'ora in cui la versione è stata DELETED .

Un timestamp in formato RFC3339 UTC "Zulu", con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z" .

deleteUser

object ( ActingUser )

Solo uscita. Identifica l'utente che DELETED la versione.

fileCount

string ( int64 format)

Solo uscita. Il numero totale di file associati alla versione.

Questo valore viene calcolato dopo che una versione è stata FINALIZED .

versionBytes

string ( int64 format)

Solo uscita. La dimensione totale dei byte archiviati della versione.

Questo valore viene calcolato dopo che una versione è stata FINALIZED .

Stato versione

Lo stato corrente noto di una versione specifica nel ciclo di vita della distribuzione.

Enumerazioni
VERSION_STATUS_UNSPECIFIED Lo stato predefinito; non deve essere utilizzato intenzionalmente.
CREATED La versione è stata creata e il contenuto è attualmente in fase di aggiunta alla versione.
FINALIZED Tutto il contenuto è stato aggiunto alla versione e la versione non può più essere modificata.
DELETED La versione è stata cancellata.
ABANDONED La versione non è stata aggiornata a FINALIZED entro 12 ore ed è stata eliminata automaticamente.
EXPIRED La versione non rientra nel limite configurato dal sito per il numero di versioni conservate, pertanto è pianificata l'eliminazione del contenuto della versione.
CLONING La versione viene clonata da un'altra versione. Tutto il contenuto è ancora in fase di copia.

ServingConfig

La configurazione relativa al modo in cui le richieste in entrata a un sito devono essere instradate ed elaborate prima di fornire il contenuto. I percorsi di richiesta URL vengono abbinati ai modelli URL specificati nella configurazione, quindi Hosting applica la configurazione applicabile in base a un ordine di priorità specifico.

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

object ( Header )

Un array di oggetti, in cui ciascun oggetto specifica un modello URL che, se abbinato al percorso URL della richiesta, attiva Hosting per applicare le intestazioni di risposta personalizzate specificate.

redirects[]

object ( Redirect )

Un array di oggetti (chiamati regole di reindirizzamento), in cui ciascuna regola specifica un modello URL che, se abbinato al percorso URL della richiesta, fa sì che Hosting risponda con un reindirizzamento al percorso di destinazione specificato.

rewrites[]

object ( Rewrite )

Un array di oggetti (chiamati regole di riscrittura), in cui ciascuna regola specifica un modello URL che, se abbinato al percorso URL della richiesta, fa sì che Hosting risponda come se al servizio fosse stato fornito l'URL di destinazione specificato.

cleanUrls

boolean

Definisce se eliminare l'estensione del file dai file caricati.

trailingSlashBehavior

enum ( TrailingSlashBehavior )

Definisce come gestire una barra finale nel percorso dell'URL.

i18n

object ( I18nConfig )

Opzionale. Definisce il comportamento di riscrittura i18n.

Header specifica un modello URL che, se abbinato al percorso URL della richiesta, attiva Hosting per applicare le intestazioni di risposta personalizzate specificate.

Rappresentazione 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.
}
Campi
headers

map (key: string, value: string)

Necessario. Le intestazioni aggiuntive da aggiungere alla risposta.

Un oggetto contenente un elenco di coppie "key": value . Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

pattern del campo dell'Unione.
Necessario. Un modello URL di stringa da confrontare con il percorso URL della richiesta per determinare se applicare questa intestazione di risposta personalizzata. Può essere un glob in stile Bash o un'espressione regolare RE2.

pattern può essere solo uno dei seguenti:
glob

string

Il glob fornito dall'utente da abbinare al percorso dell'URL della richiesta.

regex

string

L'espressione regolare RE2 fornita dall'utente da abbinare al percorso dell'URL della richiesta.

Reindirizzare

Un Redirect specifica un modello URL che, se abbinato al percorso URL della richiesta, attiva l'Hosting per rispondere con un reindirizzamento al percorso di destinazione specificato.

Rappresentazione 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.
}
Campi
statusCode

integer

Necessario. Il codice HTTP dello stato da restituire nella risposta. Deve essere un codice di stato 3xx valido.

location

string

Necessario. Il valore da inserire nell'intestazione della posizione HTTP della risposta.

La posizione può contenere valori del gruppo di acquisizione dal modello utilizzando un prefisso : per identificare il segmento e un * facoltativo per acquisire il resto dell'URL. Per esempio:

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

pattern del campo dell'Unione.
Necessario. Un modello URL di stringa da confrontare con il percorso URL della richiesta per determinare se applicare questo reindirizzamento. Può essere un glob in stile Bash o un'espressione regolare RE2.

pattern può essere solo uno dei seguenti:
glob

string

Il glob fornito dall'utente da abbinare al percorso dell'URL della richiesta.

regex

string

L'espressione regolare RE2 fornita dall'utente da abbinare al percorso dell'URL della richiesta.

Riscrivere

Una Rewrite specifica un modello URL che, se abbinato al percorso URL della richiesta, fa sì che Hosting risponda come se al servizio fosse stato fornito l'URL di destinazione specificato.

Rappresentazione 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.
}
Campi
functionRegion

string

Opzionale. Specificare un'area cloud per le chiamate di funzioni riscritte. Se non fornito, il valore predefinito è us-central1.

pattern del campo dell'Unione.
Necessario. Un modello URL di stringa da confrontare con il percorso URL della richiesta per determinare se applicare questa riscrittura. Può essere un glob in stile Bash o un'espressione regolare RE2.

pattern può essere solo uno dei seguenti:
glob

string

Il glob fornito dall'utente da abbinare al percorso dell'URL della richiesta.

regex

string

L'espressione regolare RE2 fornita dall'utente da abbinare al percorso dell'URL della richiesta.

behavior in campo dell'Unione.
Necessario. Il comportamento della riscrittura.

behavior può essere solo uno dei seguenti:
path

string

Il percorso URL in cui riscrivere la richiesta.

function

string

La funzione a cui inoltrare le richieste. Deve corrispondere esattamente al nome della funzione esportata.

run

object ( CloudRunRewrite )

La richiesta verrà inoltrata a Cloud Run.

CloudRunRewrite

Una riscrittura configurata che indirizza le richieste a un servizio Cloud Run. Se il servizio Cloud Run non esiste durante l'impostazione o l'aggiornamento della configurazione di hosting Firebase, la richiesta non riesce. Eventuali errori del servizio Cloud Run vengono trasmessi all'utente finale (ad esempio, se elimini un servizio, qualsiasi richiesta indirizzata a quel servizio riceve un errore 404 ).

Rappresentazione JSON
{
  "serviceId": string,
  "region": string,
  "tag": string
}
Campi
serviceId

string

Necessario. ID definito dall'utente del servizio Cloud Run.

region

string

Opzionale. Regione fornita dall'utente in cui è ospitato il servizio Cloud Run.

Il valore predefinito è us-central1 se non fornito.

tag

string

Opzionale. Tag TrafficConfig fornito dall'utente a cui inviare il traffico.

Se omesso, il traffico viene inviato all'URI a livello di servizio

TrailingSlashBehavior

Definisce se aggiungere o rimuovere una barra finale dal percorso dell'URL della richiesta.

Enumerazioni
TRAILING_SLASH_BEHAVIOR_UNSPECIFIED

Non è specificato alcun comportamento.

I file vengono serviti solo nella posizione esatta e le barre finali vengono aggiunte solo agli indici delle directory.

ADD Le barre finali vengono aggiunte agli indici delle directory e a qualsiasi percorso URL che non termina con un'estensione di file.
REMOVE Le barre finali vengono rimosse dagli indici delle directory e da qualsiasi percorso URL che non termina con un'estensione di file.

I18nConfig

Se fornite, le riscritture i18n sono abilitate.

Rappresentazione JSON
{
  "root": string
}
Campi
root

string

Necessario. Il percorso fornito dall'utente in cui verranno cercati i contenuti specifici del paese e della lingua all'interno della directory pubblica.

Metodi

clone

 Crea una nuova versione nel sito di destinazione specificato utilizzando il contenuto della versione specificata.

create

 Crea una nuova versione per il sito specificato.

delete

 Elimina la versione specificata.

get

 Ottieni la versione specificata che è stata creata per il sito specificato.

list

 Elenca le versioni create per il sito specificato.

patch

 Aggiorna i metadati specificati per la versione specificata.

populateFiles

 Aggiunge file di contenuto alla versione specificata.