RuntimeOptions interface

Options de configuration pour une fonction applicable au moment de l'exécution.

Signature:

export interface RuntimeOptions 

Propriétés

RuntimeOptions.consumeAppCheckToken

Détermine si le jeton Firebase App Check est consommé sur demande. La valeur par défaut est false.

Définissez cette valeur sur true pour activer la fonctionnalité de protection contre la relecture d'App Check en consommant le jeton App Check sur demande appelable. Les jetons déjà consommés auront la propriété request.app.alreadyConsumed définie sur true.

Les jetons ne sont considérés comme consommés que s'ils sont envoyés au service App Check en définissant cette option sur true. Les autres utilisations du jeton ne le consomment pas.

Cette fonctionnalité de protection contre la relecture nécessite un appel réseau supplémentaire vers le backend App Check et oblige les clients à obtenir une nouvelle attestation auprès des fournisseurs d'attestation choisis. Cela peut donc avoir un impact négatif sur les performances et potentiellement épuiser plus rapidement les quotas de vos fournisseurs d'attestation. Utilisez cette fonctionnalité uniquement pour protéger les opérations à faible volume, critiques pour la sécurité ou coûteuses.

Cette option n'affecte pas l' enforceAppCheck . Si ce dernier est défini sur true, la fonction appelable répondra automatiquement avec un code d'état 401 non autorisé lorsque la demande inclut un jeton App Check non valide. Lorsque la demande inclut des jetons App Check valides mais consommés, les demandes ne seront pas automatiquement rejetées. Au lieu de cela, la propriété request.app.alreadyConsumed sera définie sur true et transmettra l'exécution au code du gestionnaire pour prendre d'autres décisions, comme exiger des contrôles de sécurité supplémentaires ou rejeter la demande.

Signature:

consumeAppCheckToken?: boolean;

RuntimeOptions.enforceAppCheck

Détermine si Firebase AppCheck est appliqué.

Lorsque cela est vrai, les demandes contenant des jetons non valides répondent automatiquement avec une erreur 401 (non autorisée). Lorsqu'elles sont fausses, les requêtes avec des jetons non valides définissent context.app sur undefiend.

Signature:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

Politique d'échec de la fonction, boolean true équivalant à fournir un objet de nouvelle tentative vide.

Signature:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

Paramètres d'entrée qui contrôlent d'où cette fonction peut être appelée.

Signature:

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

RuntimeOptions.invoker

Invocateur pour définir le contrôle d’accès sur les fonctions https.

Signature:

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

RuntimeOptions.labels

Libellés utilisateur à définir sur la fonction.

Signature:

labels?: Record<string, string>;

RuntimeOptions.maxInstances

Nombre maximum d'instances réelles autorisées à s'exécuter en parallèle.

Signature:

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

RuntimeOptions.mémoire

Quantité de mémoire à allouer à la fonction.

Signature:

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

RuntimeOptions.minInstances

Nombre minimum d'instances réelles à exécuter à un moment donné.

Les instances seront facturées pour l'allocation de mémoire et 10 % de l'allocation de processeur lorsqu'elles sont inactives.

Signature:

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

RuntimeOptions.preserveExternalChanges

Contrôle si la configuration de la fonction modifiée en dehors de la source de la fonction est conservée. La valeur par défaut est false.

Lors de la configuration d'une configuration disponible sur la plate-forme sous-jacente qui n'est pas encore disponible dans le SDK Firebase Functions, nous vous recommandons fortement de définir preserveExternalChanges sur true . Sinon, lorsque le SDK Firebase Functions publie une nouvelle version du SDK prenant en charge la configuration manquante, le paramètre configuré manuellement de votre fonction risque d'être effacé par inadvertance.

Signature:

preserveExternalChanges?: boolean;

RuntimeOptions.secrets

Signature:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount

Compte de service spécifique sous lequel la fonction doit être exécutée.

Signature:

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

RuntimeOptions.timeoutSeconds

Délai d'expiration de la fonction en secondes, les valeurs possibles sont comprises entre 0 et 540.

Signature:

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

RuntimeOptions.vpcConnector

Connectez la fonction cloud au connecteur VPC spécifié.

Signature:

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

RuntimeOptions.vpcConnectorEgressSettings

Paramètres de sortie pour le connecteur VPC.

Signature:

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