REST Resource: sites.versions

Recurso: Versão

Uma 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 completo do recurso 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 ), carregue todos os arquivos desejados para a versão e atualize a versão para o status FINALIZED .

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

Você também pode alterar o status de uma versão para DELETED chamando versions.delete .

config

object ( ServingConfig )

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

labels

map (key: string, value: string)

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

Um objeto que contém uma lista de pares "key": value . Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

createTime

string ( Timestamp format)

Somente 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 )

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

finalizeTime

string ( Timestamp format)

Somente saída. O momento 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 )

Somente saída. Identifica o usuário que FINALIZED a versão.

deleteTime

string ( Timestamp format)

Somente 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 )

Somente saída. Identifica o usuário que DELETED a versão.

fileCount

string ( int64 format)

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

Este valor é calculado depois que uma versão é FINALIZED .

versionBytes

string ( int64 format)

Somente saída. O tamanho total de bytes armazenados da versão.

Este valor é calculado depois que uma versão é FINALIZED .

VersãoStatus

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 deve ser usado intencionalmente.
CREATED A versão foi criada e o conteúdo está sendo adicionado a ela.
FINALIZED Todo o conteúdo foi adicionado à versão e a versão 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 configurado pelo site para o número de versões retidas, portanto, o conteúdo da versão está agendado para exclusão.
CLONING A versão está sendo clonada de outra versão. Todo o conteúdo ainda está sendo copiado.

ServindoConfig

A configuração de como as solicitações recebidas em um site devem ser roteadas e processadas antes de servir o conteúdo. Os caminhos de solicitação de URL são comparados aos padrões de URL especificados na configuração e, 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, onde cada objeto especifica um padrão de URL que, se corresponder ao caminho do URL da solicitação, aciona o Hosting para aplicar os cabeçalhos de resposta personalizados especificados.

redirects[]

object ( Redirect )

Uma matriz de objetos (chamados regras de redirecionamento), onde cada regra especifica um padrão de URL que, se corresponder ao caminho do URL da solicitação, aciona o Hosting para responder com um redirecionamento para o caminho de destino especificado.

rewrites[]

object ( Rewrite )

Uma matriz de objetos (chamados de regras de reescrita), onde cada regra especifica um padrão de URL que, se corresponder ao caminho do URL da solicitação, aciona 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 deve ser removida dos arquivos carregados.

trailingSlashBehavior

enum ( TrailingSlashBehavior )

Define como lidar com uma barra final no caminho da URL.

i18n

object ( I18nConfig )

Opcional. Define o comportamento de reescrita i18n.

Um Header especifica um padrão de URL que, se corresponder ao caminho do URL da solicitação, aciona 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 adicionados à resposta.

Um objeto que contém uma lista de pares "key": value . Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

pattern de campo de união.
Obrigatório. Um padrão de URL de string para corresponder ao caminho do URL da 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 pode ser apenas um dos seguintes:
glob

string

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

regex

string

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

Redirecionar

Um Redirect especifica um padrão de URL que, se corresponder ao caminho do URL da solicitação, aciona o Hosting para responder com um redirecionamento para o 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 código HTTP de status a ser retornado na resposta. Deve ser um código de status 3xx válido.

location

string

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

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

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

pattern de campo de união.
Obrigatório. Um padrão de URL de string para corresponder ao caminho do URL da solicitação para determinar se esse redirecionamento deve ser aplicado. Pode ser um glob no estilo Bash ou uma expressão regular RE2.

pattern pode ser apenas um dos seguintes:
glob

string

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

regex

string

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

Reescrever

Uma Rewrite especifica um padrão de URL que, se corresponder ao caminho do URL da solicitação, aciona 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 fornecido, o padrão é us-central1.

pattern de campo de união.
Obrigatório. Um padrão de URL de string para corresponder ao caminho do URL da solicitação para determinar se essa reescrita deve ser aplicada. Pode ser um glob no estilo Bash ou uma expressão regular RE2.

pattern pode ser apenas um dos seguintes:
glob

string

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

regex

string

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

behavior do campo sindical.
Obrigatório. O comportamento da reescrita.

behavior pode ser apenas um dos seguintes:
path

string

O caminho da URL para reescrever a solicitação.

function

string

A função para fazer proxy de solicitações. Deve corresponder exatamente ao nome da função exportada.

run

object ( CloudRunRewrite )

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

CloudRunRewrite

Uma reescrita configurada que direciona solicitações para um serviço do Cloud Run. Se o serviço Cloud Run não existir ao definir ou atualizar a configuração do Firebase Hosting, a solicitação falhará. Todos os erros do serviço Cloud Run são transmitidos ao usuário final (por exemplo, se você excluir um serviço, todas as solicitações direcionadas a esse serviço receberão um erro 404 ).

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

string

Obrigatório. ID definido pelo usuário do serviço Cloud Run.

region

string

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

O padrão é us-central1 se não for fornecido.

tag

string

Opcional. Tag TrafficConfig fornecida pelo usuário para a qual enviar tráfego.

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

TrailingSlashBehavior

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

Enums
TRAILING_SLASH_BEHAVIOR_UNSPECIFIED

Nenhum comportamento é especificado.

Os arquivos são servidos apenas em seu local exato e as barras finais são adicionadas apenas aos índices de diretório.

ADD Barras finais são adicionadas aos índices de diretório, bem como a qualquer caminho de URL que não termine em uma extensão de arquivo.
REMOVE As barras finais são removidas dos índices de diretório, bem como de qualquer caminho de URL que não termine em uma extensão de arquivo.

I18nConfig

Se fornecido, as reescritas i18n serão habilitadas.

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

string

Obrigatório. O caminho fornecido pelo usuário onde o conteúdo específico do país e do 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

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