GlobalOptions interface

GlobalOptions sont des options qui peuvent être définies sur l'ensemble d'un projet. Ces options sont communes aux fonctions HTTPS et de gestion d’événements.

Signature:

export interface GlobalOptions 

Propriétés

GlobalOptions.concurrency

Nombre de requêtes qu'une fonction peut traiter en même temps.

Peut être appliqué uniquement aux fonctions exécutées sur Cloud Functions (2e génération)). Une valeur null restaure la concurrence par défaut (80 lorsque CPU > = 1, 1 sinon). La simultanéité ne peut pas être définie sur une valeur autre que 1 si cpu est inférieur à 1. La valeur maximale de la simultanéité est de 1 000.

Signature:

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

GlobalOptions.cpu

Nombre fractionnaire de processeurs à allouer à une fonction.

La valeur par défaut est 1 pour les fonctions avec < = 2 Go de RAM et augmente pour les tailles de mémoire plus grandes. Ceci est différent des valeurs par défaut lors de l'utilisation de l'utilitaire gcloud et du montant fixe attribué dans Cloud Functions (1re génération). Pour revenir aux quantités de processeur utilisées dans gcloud ou dans Cloud Functions (1re génération), définissez cette valeur sur la valeur "gcf_gen1".

Signature:

cpu?: number | "gcf_gen1";

GlobalOptions.enforceAppCheck

Détermine si Firebase App Check est appliqué. La valeur par défaut est false.

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 event.app sur undefined .

Signature:

enforceAppCheck?: boolean;

GlobalOptions.ingressSettings

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

Signature:

ingressSettings?: IngressSetting | ResetValue;

GlobalOptions.invoker

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

Signature:

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

GlobalOptions.labels

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

Signature:

labels?: Record<string, string>;

GlobalOptions.maxInstances

Nombre maximum d'instances pouvant s'exécuter en parallèle.

Signature:

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

GlobalOptions.mémoire

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

Signature:

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

GlobalOptions.minInstances

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

Les instances sont 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;

GlobalOptions.omit

Si c’est vrai, ne déployez pas et n’émulez pas cette fonction.

Signature:

omit?: boolean | Expression<boolean>;

GlobalOptions.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 définition d'une configuration disponible sur une plate-forme sous-jacente qui n'est pas encore disponible dans le SDK Firebase pour Cloud Functions, nous vous recommandons de définir preserveExternalChanges sur true . Sinon, lorsque Google 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;

GlobalOptions.region

Région où les fonctions doivent être déployées.

Signature:

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

GlobalOptions.secrets

Signature:

secrets?: (string | SecretParam)[];

GlobalOptions.serviceAccount

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

Signature:

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

GlobalOptions.timeoutSeconds

Délai d'expiration de la fonction en secondes, les valeurs possibles sont comprises entre 0 et 540. Les fonctions HTTPS peuvent spécifier un délai d'expiration plus élevé.

Le délai d'attente minimum pour une fonction de 2e génération est de 1 s. Le délai d'attente maximum pour une fonction dépend du type de fonction : Les fonctions de gestion d'événements ont un délai d'attente maximum de 540 s (9 minutes). HTTPS et les fonctions appelables ont un délai d'attente maximum de 36,00 s (1 heure). Les fonctions de file d'attente de tâches ont un délai d'expiration maximum de 1 800 s (30 minutes).

Signature:

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

GlobalOptions.vpcConnector

Connectez une fonction à un connecteur VPC spécifié.

Signature:

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

GlobalOptions.vpcConnectorEgressSettings

Paramètres de sortie pour le connecteur VPC.

Signature:

vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;