Ir para o console

Recurso REST: sites.versions

Recurso: Version

Uma Version é o conjunto de arquivos estáticos e de configuração que determina 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 identificador exclusivo de uma versão, no formato:

sites/site-name/versions/versionID

Esse nome é fornecido no corpo da resposta quando você chama o ponto de extremidade versions.create.

status

enum (VersionStatus)

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

Para uma implantação bem-sucedida, chame o ponto de extremidade versions.create para criar uma nova versão (status CREATED), faça o upload de todos os arquivos escolhidos para a versão e, em seguida, 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.

É possível também alterar o status de uma versão para DELETED, basta chamar o ponto de extremidade versions.delete.

config

object (ServingConfig)

A configuração para o comportamento do site. Ela 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 UTC "Zulu" RFC3339 é medido com precisão de nanossegundos. Exemplo: "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 UTC "Zulu" RFC3339 é medido com precisão de nanossegundos. Exemplo: "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 UTC "Zulu" RFC3339 é medido com precisão de nanossegundos. Exemplo: "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.

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 padrões são correspondidos e aplicados 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)
}
Campos
headers[]

object (Header)

Uma lista de cabeçalhos de resposta personalizados que são incluídos no conteúdo se o caminho do URL de solicitação corresponder ao glob.

redirects[]

object (Redirect)

Uma lista de globs que fará com que a resposta redirecione para outro local.

rewrites[]

object (Rewrite)

Uma lista de reescritas que agirá como se o serviço recebesse o URL de destino.

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.

Header

Um header define cabeçalhos personalizados para adicionar a uma resposta caso o caminho da URL de solicitação corresponda ao padrão.

Representação JSON

{
  "glob": string,
  "headers": {
    string: string,
    ...
  }
}
Campos
glob

string

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

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

Redirect

Um redirect representa a configuração para retornar uma resposta de redirecionamento HTTP, considerando um caminho de URL de solicitação correspondente.

Representação JSON

{
  "glob": string,
  "statusCode": number,
  "location": string
}
Campos
glob

string

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

statusCode

number

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. Por exemplo:

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

Rewrite

Um rewrite representa uma regravação do conteúdo interno na versão. Se o padrão corresponder, a solicitação será processada como se fosse para o caminho de destino especificado na configuração.

Representação JSON

{
  "glob": string,

  // 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
glob

string

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

Campo da união behavior. Obrigatório. O comportamento da reescrita. behavior pode ser apenas um dos seguintes:
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
}
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 nenhum valor for fornecido, o padrão usado será us-central1.

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.

Métodos

create

Cria uma nova versão para um site.

delete

Exclui a versão especificada.