REST Resource: projects.locations.backends

Recurso: back-end

Um back-end é o principal recurso da hospedagem de apps.

Representação JSON 
{
  "name": string,
  "displayName": string,
  "servingLocality": enum (ServingLocality),
  "codebase": {
    object (Codebase)
  },
  "uri": string,
  "managedResources": [
    {
      object (ManagedResource)
    }
  ],
  "serviceAccount": string,
  "appId": string,
  "environment": string,
  "reconciling": boolean,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string
}
Campos
name

string

Identificador. O nome do recurso do back-end.

Formato:

projects/{project}/locations/{locationId}/backends/{backendId}.
displayName

string

Opcional. Nome legível por humanos. Limite de 63 caracteres.
servingLocality

enum (ServingLocality)

Obrigatório. Imutável. Especifica como o App Hosting exibirá o conteúdo para este back-end. Ele será contido em uma única região (REGIONAL_STRICT) ou poderá usar a infraestrutura de exibição replicada globalmente do App Hosting (GLOBAL_ACCESS).
codebase

object (Codebase)

Opcional. Se especificado, a conexão com um repositório de origem externo para observar atualizações orientadas a eventos para o back-end.
uri

string

Apenas saída. O URI principal para se comunicar com o back-end.
managedResources[]

object (ManagedResource)

Apenas saída. Uma lista dos recursos gerenciados por este back-end.
serviceAccount

string

Obrigatório. O nome da conta de serviço usada para o Cloud Build e o Cloud Run. Precisa ter o papel roles/firebaseapphosting.googleapis.com/computeRunner ou permissões equivalentes.
appId

string

Opcional. O ID de um app da Web associado ao back-end.
environment

string

Opcional. O nome de ambiente do back-end, usado para carregar variáveis de configuração específica do ambiente.
reconciling

boolean

Apenas saída. Um campo que, se verdadeiro, indica que o sistema está trabalhando para fazer ajustes no back-end durante uma LRO.
createTime

string (Timestamp format)

Apenas saída. Hora em que o back-end foi criado.

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

string (Timestamp format)

Apenas saída. Horário em que o back-end foi atualizado pela última vez.

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

string (Timestamp format)

Apenas saída. Horário em que o back-end foi excluído.

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

map (key: string, value: string)

Opcional. Mapa de chave-valor não estruturado que pode ser usado para organizar e categorizar objetos.

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

map (key: string, value: string)

Opcional. Mapa de chave-valor não estruturado que pode ser definido por ferramentas externas para armazenar metadados arbitrários. Elas não podem ser consultadas e precisam ser preservadas ao modificar objetos.

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

string

Apenas saída. Identificador exclusivo atribuído pelo sistema.
etag

string

Apenas saída. Soma de verificação calculada pelo servidor com base em outros valores. podem ser enviados na atualização ou exclusão para garantir que a operação seja feita no recurso esperado.

Localidade atendida

Especifica como o App Hosting replica e exibe os dados do seu back-end.

Enums
SERVING_LOCALITY_UNSPECIFIED Não especificado. Se usado, um erro será retornado.
REGIONAL_STRICT Neste modo, o App Hosting exibe o conteúdo do back-end da região mãe escolhida. O App Hosting mantém os dados e a infraestrutura de serviço somente na região escolhida e não replica os dados para outras regiões.
GLOBAL_ACCESS Neste modo, o App Hosting exibe o conteúdo do back-end a partir de vários pontos de presença (POP, na sigla em inglês) em todo o mundo. O App Hosting replica a configuração do back-end e os dados armazenados em cache para esses POPs e usa uma CDN global para diminuir ainda mais a latência de resposta. Os recursos do Cloud que o App Hosting mantém no projeto, como os serviços do Cloud Run, o build do Cloud Build e as imagens do Artifact Registry, ainda estão confinados à região pai do back-end. As respostas armazenadas em cache pela CDN podem ser armazenadas nos POPs pela duração do TTL do cache.

Base de código

A conexão com um repositório de origem externo para observar atualizações orientadas a eventos para o back-end.

Representação JSON 
{
  "repository": string,
  "rootDirectory": string
}
Campos
repository

string

Obrigatório. O nome do recurso do Developer Connect gitRepositoryLink conectado a esse back-end, no formato:

projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}

A conexão com o gitRepositoryLink precisa ser feita usando o app do GitHub para Firebase App Hosting no Console do Firebase.
rootDirectory

string

Opcional. Se repository for fornecido, o diretório relativo à raiz do repositório a ser usado como raiz do app da Web implantado.

Recurso gerenciado

Um recurso externo gerenciado pelo App Hosting no projeto.

Representação JSON 
{

  // Union field managed_resource can be only one of the following:
  "runService": {
    object (RunService)
  }
  // End of list of possible types for union field managed_resource.
}
Campos

Campo de união managed_resource.

managed_resource pode ser apenas de um dos tipos a seguir:
runService

object (RunService)

Um service do Cloud Run, gerenciado pela hospedagem de apps.

Serviço Run

Um Cloud Run service gerenciado.

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

string

Opcional. O nome do Cloud Run service, no formato:

projects/{projeto}/locations/{local}/services/{serviceId}

Métodos

create

 Cria um back-end em um projeto e local específicos.

delete

 Exclui um único back-end.

get

 Recebe informações sobre um back-end.

getTraffic

 Recebe informações sobre o tráfego de um back-end.

list

 Lista os back-ends em um determinado projeto e local.

patch

 Atualiza as informações de um único back-end.

updateTraffic

 Atualiza o tráfego de um back-end.