Firebase is back at Google I/O on May 14! Check out the sessions.

Esta página foi traduzida pela API Cloud Translation.

GlobalOptions interface

GlobalOptions são opções que podem ser definidas em um projeto inteiro. Essas opções são comuns para HTTPS e funções de manipulação de eventos.

Assinatura:

export interface GlobalOptions

Propriedades

Propriedade	Tipo	Descrição
simultaneidade	número \| Expressão <número> \| Redefinir valor	Número de solicitações que uma função pode atender de uma só vez.
CPU	número \| "gcf_gen1"	Número fracionário de CPUs a serem alocadas para uma função.
imporAppCheck	boleano	Determina se o Firebase App Check é aplicado. O padrão é falso.
configurações de ingresso	Configuração de entrada \| Redefinir valor	Configurações de entrada que controlam de onde esta função pode ser chamada.
invocador	"público" \| "privado" \| corda \| corda[]	Invoker para definir o controle de acesso em funções HTTPS.
rótulos	Registro<string, string>	Rótulos de usuário para definir a função.
maxInstâncias	número \| Expressão <número> \| Redefinir valor	Número máximo de instâncias que podem ser executadas em paralelo.
memória	Opção de memória \| Expressão <número> \| Redefinir valor	Quantidade de memória a ser alocada para uma função.
minInstâncias	número \| Expressão <número> \| Redefinir valor	Número mínimo de instâncias reais a serem executadas em um determinado momento.
omitir	booleano \| Expressão <booleano>	Se for verdade, não implemente ou emule esta função.
preservarExternalChanges	boleano	Controla se a configuração da função modificada fora da origem da função é preservada. O padrão é falso.
região	Região suportada \| corda \| Expressão <string> \| Redefinir valor	Região onde as funções devem ser implantadas.
segredos	(string \| SecretParam)[]
conta de serviço	corda \| Expressão <string> \| Redefinir valor	Conta de serviço específica para a função ser executada.
tempo limiteSegundos	número \| Expressão <número> \| Redefinir valor	Tempo limite para a função em segundos, os valores possíveis são de 0 a 540. As funções HTTPS podem especificar um tempo limite maior.
vpcConnector	corda \| Expressão <string> \| Redefinir valor	Conecte uma função a um conector VPC especificado.
vpcConnectorEgressSettings	Configuração de VpcEgress \| Redefinir valor	Configurações de saída para conector VPC.

GlobalOptions.concurrency

Número de solicitações que uma função pode atender de uma só vez.

Pode ser aplicado somente a funções em execução no Cloud Functions (2ª geração). Um valor nulo restaura a simultaneidade padrão (80 quando CPU > = 1, 1 caso contrário). A simultaneidade não pode ser definida com nenhum valor diferente de 1 se cpu for menor que 1. O valor máximo para simultaneidade é 1.000.

Assinatura:

concurrency?: number | Expression<number> | ResetValue;

Opções globais.cpu

Número fracionário de CPUs a serem alocadas para uma função.

O padrão é 1 para funções com < = 2 GB de RAM e aumenta para tamanhos de memória maiores. Isso é diferente dos padrões ao usar o utilitário gcloud e é diferente do valor fixo atribuído no Cloud Functions (1ª geração). Para reverter para as quantidades de CPU usadas no gcloud ou no Cloud Functions (1ª geração), defina-o como o valor "gcf_gen1"

Assinatura:

cpu?: number | "gcf_gen1";

GlobalOptions.enforceAppCheck

Determina se o Firebase App Check é aplicado. O padrão é falso.

Quando verdadeiro, as solicitações com tokens inválidos respondem automaticamente com um erro 401 (Não autorizado). Quando falso, solicitações com tokens inválidos definem event.app como undefined .

Assinatura:

enforceAppCheck?: boolean;

GlobalOptions.ingressSettings

Configurações de entrada que controlam de onde esta função pode ser chamada.

Assinatura:

ingressSettings?: IngressSetting | ResetValue;

GlobalOptions.invoker

Invoker para definir o controle de acesso em funções HTTPS.

Assinatura:

invoker?: "public" | "private" | string | string[];

GlobalOptions.labels

Rótulos de usuário para definir a função.

Assinatura:

labels?: Record<string, string>;

GlobalOptions.maxInstances

Número máximo de instâncias que podem ser executadas em paralelo.

Assinatura:

maxInstances?: number | Expression<number> | ResetValue;

GlobalOptions.memory

Quantidade de memória a ser alocada para uma função.

Assinatura:

memory?: MemoryOption | Expression<number> | ResetValue;

GlobalOptions.minInstances

Número mínimo de instâncias reais a serem executadas em um determinado momento.

As instâncias são cobradas pela alocação de memória e 10% da alocação de CPU enquanto ociosas.

Assinatura:

minInstances?: number | Expression<number> | ResetValue;

GlobalOptions.omit

Se for verdade, não implemente ou emule esta função.

Assinatura:

omit?: boolean | Expression<boolean>;

GlobalOptions.preserveExternalChanges

Controla se a configuração da função modificada fora da origem da função é preservada. O padrão é falso.

Ao definir a configuração disponível em uma plataforma subjacente que ainda não está disponível no SDK do Firebase para Cloud Functions, recomendamos definir preserveExternalChanges como true . Caso contrário, quando o Google lançar uma nova versão do SDK com suporte para a configuração ausente, a configuração definida manualmente da sua função poderá ser apagada inadvertidamente.

Assinatura:

preserveExternalChanges?: boolean;

Opções globais.region

Região onde as funções devem ser implantadas.

Assinatura:

region?: SupportedRegion | string | Expression<string> | ResetValue;

GlobalOptions.secrets

Assinatura:

secrets?: (string | SecretParam)[];

GlobalOptions.serviceAccount

Conta de serviço específica para a função ser executada.

Assinatura:

serviceAccount?: string | Expression<string> | ResetValue;

GlobalOptions.timeoutSeconds

Tempo limite para a função em segundos, os valores possíveis são de 0 a 540. As funções HTTPS podem especificar um tempo limite maior.

O tempo limite mínimo para uma função de 2ª geração é 1s. O tempo limite máximo para uma função depende do tipo de função: As funções de tratamento de eventos têm um tempo limite máximo de 540s (9 minutos). HTTPS e funções que podem ser chamadas têm um tempo limite máximo de 36,00s (1 hora). As funções de fila de tarefas têm um tempo limite máximo de 1.800 segundos (30 minutos).

Assinatura:

timeoutSeconds?: number | Expression<number> | ResetValue;

GlobalOptions.vpcConnector

Conecte uma função a um conector VPC especificado.

Assinatura:

vpcConnector?: string | Expression<string> | ResetValue;

GlobalOptions.vpcConnectorEgressSettings

Configurações de saída para conector VPC.

Assinatura:

vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;