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<number> | Redefinir Valor | Número de solicitações que uma função pode exibir de uma vez. |
| CPU | número | "gcf_gen1" | Número fracionário de CPUs a serem alocadas para uma função. |
| enforceAppCheck (em inglês) | booleano | Determina se o Firebase App Check é aplicado. O padrão é "false". |
| ingressSettings (em inglês) | IngressSetting | Redefinir Valor | Configurações de entrada que controlam de onde essa função pode ser chamada. |
| invoker (em inglês) | "público" | "privado" | string | string[] | Invocador para definir o controle de acesso em funções HTTPS. |
| rótulos | Record<string, string> | Rótulos de usuário a serem definidos na função. |
| maxInstances (link em inglês) | número | Expressão<number> | Redefinir Valor | Número máximo de instâncias que podem ser executadas em paralelo. |
| memória | MemoryOption | Expressão<number> | Redefinir Valor | Quantidade de memória a ser alocada para uma função. |
| minInstances (link em inglês) | número | Expressão<number> | Redefinir Valor | Número mínimo de instâncias reais a serem executadas em um determinado momento. |
| omitir | booleano | Expressão<boolean> | Se verdadeiro, não implante ou emule essa função. |
| preserveExternalChanges (link em inglês) | booleano | Controla se a configuração da função modificada fora da fonte da função é preservada. O padrão é "false". |
| region | supportedRegion | string | Expressão<string> | Redefinir Valor | Região onde as funções precisam ser implantadas. |
| segredos | (string | SecretParam)[] | |
| serviceAccount. | string | Expressão<string> | Redefinir Valor | Conta de serviço específica em que a função será executada. |
| timeoutSeconds (em inglês) | número | Expressão<number> | Redefinir Valor | O tempo limite da 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 (em inglês) | string | Expressão<string> | Redefinir Valor | Conectar uma função a um conector de VPC especificado. |
| vpcConnectorEgressSettings (em inglês) | VpcEgressSetting | Redefinir Valor | Configurações de saída para o conector VPC. |
GlobalOptions.concurrency
Número de solicitações que uma função pode exibir de uma vez.
Pode ser aplicado apenas a funções em execução no Cloud Functions (2a geração). Um valor nulo restaura a simultaneidade padrão (80 quando a CPU é maior que = 1; caso contrário, é 1). A simultaneidade não pode ser definida com qualquer valor diferente de 1 se cpu for menor que 1. O valor máximo para simultaneidade é 1.000.
Assinatura:
concurrency?: number | Expression<number> | ResetValue;
GlobalOptions.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 do valor fixo atribuído no Cloud Functions (1a geração). Para reverter para a quantidade de CPU usada no gcloud ou no Cloud Functions (1a 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 é "false".
Quando verdadeiro, as solicitações com tokens inválidos respondem automaticamente com um erro 401 (não autorizado). Quando "false", as solicitações com tokens inválidos definem event.app como undefined.
Assinatura:
enforceAppCheck?: boolean;
GlobalOptions.ingressSettings
Configurações de entrada que controlam de onde essa função pode ser chamada.
Assinatura:
ingressSettings?: IngressSetting | ResetValue;
GlobalOptions.invoker
Invocador para definir o controle de acesso em funções HTTPS.
Assinatura:
invoker?: "public" | "private" | string | string[];
GlobalOptions.labels
Rótulos de usuário a serem definidos na 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 faturadas pela alocação de memória e 10% da alocação de CPU enquanto estiverem inativas.
Assinatura:
minInstances?: number | Expression<number> | ResetValue;
GlobalOptions.omit
Se verdadeiro, não implante ou emule essa função.
Assinatura:
omit?: boolean | Expression<boolean>;
GlobalOptions.preserveExternalChanges
Controla se a configuração da função modificada fora da fonte da função é preservada. O padrão é "false".
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 compatível com a configuração ausente, a configuração definida manualmente na função poderá ser apagada acidentalmente.
Assinatura:
preserveExternalChanges?: boolean;
GlobalOptions.region
Região onde as funções precisam ser implantadas.
Assinatura:
region?: SupportedRegion | string | Expression<string> | ResetValue;
GlobalOptions.secrets
Assinatura:
secrets?: (string | SecretParam)[];
GlobalOptions.serviceAccount
Conta de serviço específica em que a função será executada.
Assinatura:
serviceAccount?: string | Expression<string> | ResetValue;
GlobalOptions.timeoutSeconds
O tempo limite da 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 2a geração é de 1 s. O tempo limite máximo de uma função depende do tipo dela: as funções de manipulação de eventos têm um tempo limite máximo de 540 segundos (9 minutos). As funções HTTPS e chamáveis têm um tempo limite máximo de 36.000s (1 hora). As funções da fila de tarefas têm um tempo limite máximo de 1.800 segundos (30 minutos).
Assinatura:
timeoutSeconds?: number | Expression<number> | ResetValue;
GlobalOptions.vpcConnector
Conectar uma função a um conector de VPC especificado.
Assinatura:
vpcConnector?: string | Expression<string> | ResetValue;
GlobalOptions.vpcConnectorEgressSettings
Configurações de saída para o conector VPC.
Assinatura:
vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;