RuntimeOptions interface

Opções de configuração para uma função aplicável em tempo de execução.

Assinatura:

export interface RuntimeOptions 

Propriedades

RuntimeOptions.consumeAppCheckToken

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

Defina como verdadeiro para ativar o recurso de proteção de reprodução do App Check consumindo o token do App Check na solicitação que pode ser chamada. Os tokens que já foram consumidos terão a propriedade request.app.alreadyConsumed definida como true.

Os tokens só são considerados consumidos se forem enviados ao serviço App Check configurando esta opção como true. Outros usos do token não o consomem.

Esse recurso de proteção de reprodução requer uma chamada de rede adicional para o back-end do App Check e força os clientes a obter um novo atestado dos provedores de atestado escolhidos. Isso pode, portanto, impactar negativamente o desempenho e potencialmente esgotar as cotas dos seus provedores de atestados mais rapidamente. Use esse recurso apenas para proteger operações de baixo volume, críticas de segurança ou caras.

Esta opção não afeta a opção enforceAppCheck . Definir o último como verdadeiro fará com que a função que pode ser chamada responda automaticamente com um código de status 401 Não autorizado quando a solicitação incluir um token do App Check inválido. Quando a solicitação inclui tokens do App Check válidos, mas consumidos, as solicitações não serão rejeitadas automaticamente. Em vez disso, a propriedade request.app.alreadyConsumed será definida como true e passará a execução para o código do manipulador para tomar decisões adicionais, 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, as solicitações com tokens inválidos definem context.app como indefeso.

Assinatura:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

Política de falha da função, com boolean true sendo equivalente a fornecer um objeto de nova tentativa vazio.

Assinatura:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

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

Assinatura:

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

RuntimeOptions.invoker

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

Assinatura:

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

RuntimeOptions.labels

Rótulos de usuário para definir a 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 em execução 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 ociosas.

Assinatura:

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

RuntimeOptions.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 na plataforma subjacente que ainda não está disponível no SDK do Firebase Functions, é altamente recomendável definir preserveExternalChanges como true . Caso contrário, quando o SDK do Firebase Functions lançar uma nova versão do SDK com suporte para a configuração ausente, a configuração configurada manualmente da sua função poderá ser apagada inadvertidamente.

Assinatura:

preserveExternalChanges?: boolean;

RuntimeOptions.secrets

Assinatura:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount

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

Assinatura:

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

RuntimeOptions.timeoutSeconds

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

Conecte a função de nuvem ao conector VPC especificado.

Assinatura:

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

RuntimeOptions.vpcConnectorEgressSettings

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

Assinatura:

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

Opções de configuração para uma função aplicável em tempo de execução.

Assinatura:

export interface RuntimeOptions 

Propriedades

RuntimeOptions.consumeAppCheckToken

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

Defina como verdadeiro para ativar o recurso de proteção de reprodução do App Check consumindo o token do App Check na solicitação que pode ser chamada. Os tokens que já foram consumidos terão a propriedade request.app.alreadyConsumed definida como true.

Os tokens só são considerados consumidos se forem enviados ao serviço App Check configurando esta opção como true. Outros usos do token não o consomem.

Esse recurso de proteção de reprodução requer uma chamada de rede adicional para o back-end do App Check e força os clientes a obter um novo atestado dos provedores de atestado escolhidos. Isso pode, portanto, impactar negativamente o desempenho e potencialmente esgotar as cotas dos seus provedores de atestados mais rapidamente. Use esse recurso apenas para proteger operações de baixo volume, críticas de segurança ou caras.

Esta opção não afeta a opção enforceAppCheck . Definir o último como verdadeiro fará com que a função que pode ser chamada responda automaticamente com um código de status 401 Não autorizado quando a solicitação incluir um token do App Check inválido. Quando a solicitação inclui tokens do App Check válidos, mas consumidos, as solicitações não serão rejeitadas automaticamente. Em vez disso, a propriedade request.app.alreadyConsumed será definida como true e passará a execução para o código do manipulador para tomar decisões adicionais, 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, as solicitações com tokens inválidos definem context.app como indefeso.

Assinatura:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

Política de falha da função, com boolean true sendo equivalente a fornecer um objeto de nova tentativa vazio.

Assinatura:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

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

Assinatura:

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

RuntimeOptions.invoker

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

Assinatura:

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

RuntimeOptions.labels

Rótulos de usuário para definir a 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 em execução 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 ociosas.

Assinatura:

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

RuntimeOptions.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 na plataforma subjacente que ainda não está disponível no SDK do Firebase Functions, é altamente recomendável definir preserveExternalChanges como true . Caso contrário, quando o SDK do Firebase Functions lançar uma nova versão do SDK com suporte para a configuração ausente, a configuração configurada manualmente da sua função poderá ser apagada inadvertidamente.

Assinatura:

preserveExternalChanges?: boolean;

RuntimeOptions.secrets

Assinatura:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount

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

Assinatura:

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

RuntimeOptions.timeoutSeconds

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

Conecte a função de nuvem ao conector VPC especificado.

Assinatura:

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

RuntimeOptions.vpcConnectorEgressSettings

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

Assinatura:

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