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 des événements.
Signature:
export interface GlobalOptions
Propriétés
| Propriété | Taper | Description |
|---|---|---|
| simultanéité | nombre | Expression<nombre> | Valeur de réinitialisation | Nombre de requêtes qu'une fonction peut traiter simultanément. |
| CPU | nombre | "gcf_gen1" | Nombre fractionnaire de CPU à allouer à une fonction. |
| appliquerAppCheck | booléen | Détermine si Firebase AppCheck est appliqué. La valeur par défaut est false. |
| paramètres d'entrée | Paramètre d'entrée | Valeur de réinitialisation | Paramètres d'entrée qui contrôlent d'où cette fonction peut être appelée. |
| invocateur | "publique" | "privé" | chaîne | chaîne[] | Invoker pour définir le contrôle d'accès sur les fonctions https. |
| Étiquettes | Enregistrer<chaîne, chaîne> | Libellés utilisateur à définir sur la fonction. |
| maxInstances | nombre | Expression<nombre> | Valeur de réinitialisation | Nombre maximal d'instances à exécuter en parallèle. |
| mémoire | OptionMémoire | Expression<nombre> | Valeur de réinitialisation | Quantité de mémoire à allouer à une fonction. |
| minInstances | nombre | Expression<nombre> | Valeur de réinitialisation | Nombre minimal d'instances réelles à exécuter à un moment donné. |
| omettre | booléen | Expression<booléen> | Si vrai, ne déployez pas ou n'émulez pas cette fonction. |
| preserveExternalChanges | booléen | 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. |
| région | Région prise en charge | chaîne | Région où les fonctions doivent être déployées. |
| secrets | (chaîne | SecretParam)[] | |
| serviceAccount | chaîne | Valeur de réinitialisation | Compte de service spécifique pour la fonction à exécuter. |
| timeoutSecondes | nombre | Expression<nombre> | Valeur de réinitialisation | 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 long. |
| vpcConnector | chaîne | Expression<chaîne> | Valeur de réinitialisation | Connectez la fonction cloud au connecteur VPC spécifié. |
| vpcConnectorEgressSettingsvpcConnectorEgressSettings | VpcEgressSetting | Valeur de réinitialisation | Paramètres de sortie pour le connecteur VPC. |
GlobalOptions.concurrency
Nombre de requêtes qu'une fonction peut traiter simultanément.
Ne peut être appliqué qu'aux fonctions exécutées sur Cloud Functions v2. Une valeur nulle restaure la simultanéité 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 CPU à allouer à une fonction.
Par défaut à 1 pour les fonctions avec < = 2 Go de RAM et augmente pour les plus grandes tailles de mémoire. Ceci est différent des valeurs par défaut lors de l'utilisation de l'utilitaire gcloud et est différent du montant fixe attribué dans la génération 1 de Google Cloud Functions. Pour rétablir les quantités de CPU utilisées dans gcloud ou dans la génération 1 de Cloud Functions, définissez-le sur la valeur "gcf_gen1"
Signature:
cpu?: number | "gcf_gen1";
GlobalOptions.enforceAppCheck
Détermine si Firebase AppCheck est appliqué. La valeur par défaut est false.
Lorsqu'il est vrai, les demandes avec des jetons non valides répondent automatiquement avec une erreur 401 (non autorisée). Lorsque false, les demandes avec des jetons non valides définissent event.app sur undefiend.
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
Invoker 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.maxInstancesGlobalOptions.maxInstances
Nombre maximal d'instances à exécuter en parallèle.
Signature:
maxInstances?: number | Expression<number> | ResetValue;
GlobalOptions.memory
Quantité de mémoire à allouer à une fonction.
Signature:
memory?: MemoryOption | Expression<number> | ResetValue;
GlobalOptions.minInstances
Nombre minimal 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 CPU lorsqu'elles sont inactives.
Signature:
minInstances?: number | Expression<number> | ResetValue;
GlobalOptions.omit
Si vrai, ne déployez pas ou 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.
Lorsque vous définissez une configuration disponible sur la plate-forme sous-jacente qui n'est pas encore disponible dans le SDK Firebase Functions, nous vous recommandons vivement de définir preserveExternalChanges sur true . Sinon, lorsque le SDK Firebase Functions publie une nouvelle version du SDK avec prise en charge de la configuration manquante, le paramètre configuré manuellement de votre fonction peut être effacé par inadvertance.
Signature:
preserveExternalChanges?: boolean;
GlobalOptions.regionGlobalOptions.region
Région où les fonctions doivent être déployées.
Signature:
region?: SupportedRegion | string;
GlobalOptions.secrets
Signature:
secrets?: (string | SecretParam)[];
GlobalOptions.serviceAccount
Compte de service spécifique pour la fonction à exécuter.
Signature:
serviceAccount?: string | ResetValue;
GlobalOptions.timeoutSecondsGlobalOptions.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 long.
Le délai d'attente minimum pour une fonction gen 2 est de 1 s. Le délai maximum d'une fonction dépend du type de fonction : Les fonctions de gestion d'événements ont un délai maximum de 540 s (9 minutes). HTTPS et les fonctions appelables ont un délai maximum de 36,00s (1 heure). Les fonctions de file d'attente de tâches ont un délai d'expiration maximal de 1 800 s (30 minutes)
Signature:
timeoutSeconds?: number | Expression<number> | ResetValue;
GlobalOptions.vpcConnector
Connectez la fonction cloud au connecteur VPC spécifié.
Signature:
vpcConnector?: string | Expression<string> | ResetValue;
GlobalOptions.vpcConnectorEgressSettings
Paramètres de sortie pour le connecteur VPC.
Signature:
vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;