RuntimeOptions interface

Opções de configuração para uma função aplicáveis no momento da execução.

Assinatura:

export interface RuntimeOptions 

Propriedades

RuntimeOptions.consumeAppCheckToken

Determina se o token do Firebase App Check é consumido mediante solicitação. O padrão é "false".

Defina como "true" para ativar o recurso de proteção contra repetição do App Check consumindo o token do App Check em uma solicitação chamável. Os tokens já consumidos terão a propriedade request.app.alreadyConsumed definida como verdadeira.

Os tokens só serão considerados como consumidos se forem enviados para o serviço do App Check definindo essa opção como "true". O token não é usado em outros usos.

Esse recurso de proteção contra repetição exige uma chamada de rede extra para o back-end do App Check e força os clientes a receber um novo atestado dos provedores de atestado escolhidos. Isso pode afetar negativamente o desempenho e, possivelmente, sobrecarregar os provedores de atestado as cotas com mais rapidez. Use esse recurso apenas para proteger operações de baixo volume, essenciais para a segurança ou caras.

Essa opção não afeta a opção enforceAppCheck. Definir o último como verdadeiro fará com que a função chamável responda automaticamente com um código de status 401 Unused quando a solicitação inclui um token inválido do App Check. Quando a solicitação inclui tokens do App Check válidos, mas consumidos, elas não são rejeitadas automaticamente. Em vez disso, a propriedade request.app.alreadyConsumed será definida como verdadeira e vai transmitir a execução ao código do gerenciador para tomar outras decisões, como exigir verificações de segurança adicionais ou rejeitar a solicitação.

Assinatura:

consumeAppCheckToken?: boolean;

RuntimeOptions.enforceAppCheck

Determina se o Firebase AppCheck é aplicado.

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 context.app como indefiend.

Assinatura:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

Política de falhas da função, com o booleano true sendo equivalente a fornecer um objeto de repetição vazio.

Assinatura:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

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

Assinatura:

ingressSettings?: (typeof INGRESS_SETTINGS_OPTIONS)[number] | ResetValue;

RuntimeOptions.invoker

Invocador para definir o controle de acesso em funções https.

Assinatura:

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

RuntimeOptions.labels

Rótulos de usuário a serem definidos na função.

Assinatura:

labels?: Record<string, string>;

RuntimeOptions.maxInstances

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

Assinatura:

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

RuntimeOptions.memory

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

Assinatura:

memory?: (typeof VALID_MEMORY_OPTIONS)[number] | Expression<number> | ResetValue;

RuntimeOptions.minInstances

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

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

Assinatura:

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

RuntimeOptions.preserveExternalChanges

Controla se a configuração da função modificada fora da fonte da função é preservada. O padrão é "false".

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

Assinatura:

preserveExternalChanges?: boolean;

RuntimeOptions.secrets

Assinatura:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount

Conta de serviço específica em que a função será executada.

Assinatura:

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

RuntimeOptions.timeoutSeconds

O tempo limite da função é em segundos. Os valores possíveis são de 0 a 540.

Assinatura:

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

RuntimeOptions.vpcConnector

Conectar a função do Cloud ao conector de VPC especificado.

Assinatura:

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

RuntimeOptions.vpcConnectorEgressSettings

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

Assinatura:

vpcConnectorEgressSettings?: (typeof VPC_EGRESS_SETTINGS_OPTIONS)[number] | ResetValue;