REST Resource: sites.versions

Recurso: Version

Um Version é uma configuração e uma coleção de arquivos estáticos que determinam como um site é exibido.

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

string

O nome de recurso totalmente qualificado para a versão, no formato:

sites/SITE_ID/versions/VERSION_ID

Esse nome é fornecido no corpo da resposta quando você chama versions.create.
status

enum (VersionStatus)

O status de implantação da versão.

Para uma implantação bem-sucedida, chame versions.create para criar uma nova versão (status CREATED), faça upload de todos os arquivos desejados e atualize a versão para o status FINALIZED.

Se você deixar a versão no estado CREATED por mais de 12 horas, o sistema a marcará automaticamente como ABANDONED.

Também é possível alterar o status de uma versão para DELETED chamando versions.delete.
config

object (ServingConfig)

A configuração para o comportamento do site. Essa configuração existe no arquivo firebase.json.
labels

map (key: string, value: string)

Os rótulos usados para metadados extras e/ou filtragem.

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

string (Timestamp format)

Apenas saída. A hora em que a versão foi criada.

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

object (ActingUser)

Apenas saída. Identifica o usuário que criou a versão.
finalizeTime

string (Timestamp format)

Apenas saída. A hora em que a versão foi FINALIZED.

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

object (ActingUser)

Apenas saída. Identifica o usuário que marcou a versão como FINALIZED.
deleteTime

string (Timestamp format)

Apenas saída. A hora em que a versão foi DELETED.

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

object (ActingUser)

Apenas saída. Identifica o usuário que marcou a versão como DELETED.
fileCount

string (int64 format)

Apenas saída. O número total de arquivos associados à versão.

Este valor é calculado após uma versão ser FINALIZED.
versionBytes

string (int64 format)

Apenas saída. O total de bytesize armazenado da versão.

Este valor é calculado após uma versão ser FINALIZED.

VersionStatus

O status atual conhecido de uma versão específica no ciclo de vida de implantação.

Enums
VERSION_STATUS_UNSPECIFIED O status padrão. Não pode ser usado intencionalmente.
CREATED A versão foi criada e o conteúdo está sendo adicionado à versão.
FINALIZED Todo o conteúdo foi adicionado à versão e ela não pode mais ser alterada.
DELETED A versão foi excluída.
ABANDONED A versão não foi atualizada para FINALIZED em 12 horas e foi excluída automaticamente.
EXPIRED A versão está fora do limite de versões retidas configurado para o site. Por isso, o conteúdo da versão está programado para exclusão.
CLONING A versão está sendo clonada de outra versão. Todo o conteúdo ainda está sendo copiado.

ServingConfig

A configuração de como as solicitações recebidas em um site precisam ser roteadas e processadas antes de veicular o conteúdo. Os caminhos de solicitação do URL são comparados aos padrões de URL especificados na configuração. Em seguida, o Hosting aplica a configuração aplicável de acordo com uma ordem de prioridade específica.

.
Representação JSON 
{
  "headers": [
    {
      object (Header)
    }
  ],
  "redirects": [
    {
      object (Redirect)
    }
  ],
  "rewrites": [
    {
      object (Rewrite)
    }
  ],
  "cleanUrls": boolean,
  "trailingSlashBehavior": enum (TrailingSlashBehavior),
  "i18n": {
    object (I18nConfig)
  }
}
Campos
headers[]

object (Header)

Uma matriz de objetos em que cada objeto especifica um padrão de URL que, em caso de correspondência com o caminho do URL da solicitação, acionará o Hosting para aplicar os cabeçalhos de resposta personalizados especificados.
redirects[]

object (Redirect)

Uma matriz de objetos (chamadas de regras de redirecionamento), em que cada regra especifica um padrão de URL que, se corresponder ao caminho do URL de solicitação, acionará o Hosting para responder com um redirecionamento para o caminho de destino especificado.
rewrites[]

object (Rewrite)

Uma matriz de objetos (chamadas de regras de substituição), em que cada regra especifica um padrão de URL que, se corresponder ao caminho do URL de solicitação, acionará o Hosting para responder como se o serviço tivesse recebido o URL de destino especificado.
cleanUrls

boolean

Define se a extensão do arquivo dos arquivos enviados será descartada.
trailingSlashBehavior

enum (TrailingSlashBehavior)

Define como processar uma barra final no caminho do URL.
i18n

object (I18nConfig)

Opcional. Define o comportamento de regravação de i18n.

Um Header especifica um padrão de URL que, se corresponder ao caminho do URL da solicitação, acionará o Hosting para aplicar os cabeçalhos de resposta personalizados especificados.

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

map (key: string, value: string)

Obrigatório. Os cabeçalhos adicionais a serem acrescentados à resposta.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Campo de união pattern.
Obrigatório. Um padrão de URL de string que corresponde ao caminho do URL de solicitação para determinar se esse cabeçalho de resposta personalizado deve ser aplicado. Pode ser um glob no estilo Bash ou uma expressão regular RE2.

pattern só pode ser de um dos tipos a seguir:
glob

string

O glob fornecido pelo usuário para corresponder ao caminho do URL de solicitação.
regex

string

A expressão regular RE2 fornecida pelo usuário para corresponder ao caminho do URL de solicitação.

Redirecionamento

Um Redirect especifica um padrão de URL que, se corresponder ao caminho do URL da solicitação, acionará o Hosting para responder com um redirecionamento ao caminho de destino especificado.

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

integer

Obrigatório. O status do código HTTP a ser retornado na resposta. Precisa ser um código de status 3xx válido.
location

string

Obrigatório. O valor a ser colocado no cabeçalho de local HTTP da resposta.

O local pode conter valores do grupo de captura do padrão usando um prefixo : para identificar o segmento e um * opcional para capturar o restante do URL. Exemplo:

"glob": "/:capture*",
"statusCode": 301,
"location": "https://example.com/foo/:capture"
Campo de união pattern.
Obrigatório. Um padrão de URL de string que corresponde ao caminho do URL de solicitação para determinar se esse redirecionamento deve ser aplicado. Pode ser um glob no estilo Bash ou uma expressão regular RE2.

pattern só pode ser de um dos tipos a seguir:
glob

string

O glob fornecido pelo usuário para corresponder ao caminho do URL de solicitação.
regex

string

A expressão regular RE2 fornecida pelo usuário para corresponder ao caminho do URL de solicitação.

Reprogramação

Um Rewrite especifica um padrão de URL que, se corresponder ao caminho do URL da solicitação, acionará o Hosting para responder como se o serviço tivesse recebido o URL de destino especificado.

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

string

Opcional. Especifique uma região do Cloud para invocações reescritas do Functions. Se não for informado, o padrão será us-central1.
Campo de união pattern.
Obrigatório. Um padrão de URL de string que corresponde ao caminho do URL de solicitação para determinar se essa regravação deve ser aplicada. Pode ser um glob no estilo Bash ou uma expressão regular RE2.

pattern só pode ser de um dos tipos a seguir:
glob

string

O glob fornecido pelo usuário para corresponder ao caminho do URL de solicitação.
regex

string

A expressão regular RE2 fornecida pelo usuário para corresponder ao caminho do URL de solicitação.
Campo de união behavior.
Obrigatório. O comportamento da regravação.

behavior só pode ser de um dos tipos a seguir:
path

string

O caminho do URL para reescrever a solicitação.
function

string

A função para solicitações. Precisa corresponder exatamente ao nome da função exportada.
run

object (CloudRunRewrite)

A solicitação será encaminhada para o Cloud Run.

CloudRunRewrite

Uma regravação configurada que direciona solicitações para um serviço do Cloud Run. Se o serviço não existir quando você definir ou atualizar sua configuração do Firebase Hosting, a solicitação falhará. Qualquer erro do serviço do Cloud Run será transmitido para o usuário final (por exemplo, se você excluir um serviço, quaisquer solicitações direcionadas a ele receberão um erro 404).

Representação JSON 
{
  "serviceId": string,
  "region": string,
  "tag": string
}
Campos
serviceId

string

Obrigatório. Código definido pelo usuário do serviço do Cloud Run.
region

string

Opcional. Região fornecida pelo usuário em que o serviço do Cloud Run está hospedado.

Se não informado, o padrão será us-central1.
tag

string

Opcional. Tag TrafficConfig fornecida pelo usuário para envio de tráfego.

Quando omitido, o tráfego é enviado para o URI de todo o serviço

TrailingSlashBehavior

Define se uma barra final precisa ser adicionada ou removida do caminho do URL de solicitação.

Enums
TRAILING_SLASH_BEHAVIOR_UNSPECIFIED

Nenhum comportamento é especificado.

Os arquivos são exibidos apenas no local exato, e as barras finais são adicionadas apenas aos índices de diretório.
ADD Barras à direita são adicionadas aos índices de diretório, bem como a qualquer caminho de URL que não termina em uma extensão de arquivo.
REMOVE As barras à direita são removidas dos índices de diretório, bem como de qualquer caminho de URL que não termina em uma extensão de arquivo.

I18nConfig

Se fornecido, as substituições de i18n são ativadas.

Representação JSON 
{
  "root": string
}
Campos
root

string

Obrigatório. O caminho fornecido pelo usuário em que o conteúdo específico de país e idioma será procurado no diretório público.

Métodos

clone

 Cria uma nova versão no site de destino especificado usando o conteúdo da versão especificada.

create

 Cria uma nova versão para o site especificado.

delete

 Exclui a versão especificada.

get

 Acessa a versão especificada que foi criada para o site especificado.

list

 Lista as versões que foram criadas para o site especificado.

patch

 Atualiza os metadados especificados para a versão especificada.

populateFiles

 Adiciona arquivos de conteúdo à versão especificada.