https.HttpsOptions interface

Options pouvant être définies sur une fonction HTTPS onRequest.

Signature:

export interface HttpsOptions extends Omit<GlobalOptions, "region"> 

Étend : Omettre < 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.
cors chaîne | booléen | RegExp | Tableau<chaîne | RegExp> Si vrai, autorise CORS sur les requêtes adressées à cette fonction. S'il s'agit d'une string ou RegExp , autorise les demandes provenant de domaines qui correspondent à la valeur fournie. S'il s'agit d'un Array , autorise les requêtes provenant de domaines correspondant à au moins une entrée du tableau. Par défaut, true pour https.CallableFunction et false sinon.
CPU nombre | "gcf_gen1" Nombre fractionnaire de CPU à allouer à une fonction.
paramètres d'entrée options. 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 options. 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.
région Région prise en charge | chaîne | Tableau< RégionPrise en Charge | chaîne> Les fonctions HTTP peuvent remplacer les options globales et peuvent spécifier plusieurs régions dans lesquelles se déployer.
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 options. VpcEgressSetting | Valeur de réinitialisation Paramètres de sortie pour le connecteur VPC.

https.HttpsOptions.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;

https.HttpsOptions.cors

Si vrai, autorise CORS sur les requêtes adressées à cette fonction. S'il s'agit d'une string ou RegExp , autorise les requêtes provenant de domaines qui correspondent à la valeur fournie. S'il s'agit d'un Array , autorise les requêtes provenant de domaines correspondant à au moins une entrée du tableau. Par défaut, true pour https.CallableFunction et false sinon.

Signature:

cors?: string | boolean | RegExp | Array<string | RegExp>;

https.HttpsOptions.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";

https.HttpsOptions.ingressSettings

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

Signature:

ingressSettings?: options.IngressSetting | ResetValue;

https.HttpsOptions.invoker

Invoker pour définir le contrôle d'accès sur les fonctions https.

Signature:

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

https.HttpsOptions.labels

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

Signature:

labels?: Record<string, string>;

https.HttpsOptions.maxInstances

Nombre maximal d'instances à exécuter en parallèle.

Signature:

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

https.HttpsOptions.memory

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

Signature:

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

https.HttpsOptions.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;

https.HttpsOptions.omit

Si vrai, ne déployez pas ou n'émulez pas cette fonction.

Signature:

omit?: boolean | Expression<boolean>;

https.HttpsOptions.region

Les fonctions HTTP peuvent remplacer les options globales et peuvent spécifier plusieurs régions dans lesquelles se déployer.

Signature:

region?: SupportedRegion | string | Array<SupportedRegion | string>;

https.HttpsOptions.secrets

Signature:

secrets?: (string | SecretParam)[];

https.HttpsOptions.serviceAccount

Compte de service spécifique pour la fonction à exécuter.

Signature:

serviceAccount?: string | ResetValue;

https.HttpsOptions.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;

https.HttpsOptions.vpcConnector

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

Signature:

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

https.HttpsOptions.vpcConnectorEgressSettings

Paramètres de sortie pour le connecteur VPC.

Signature:

vpcConnectorEgressSettings?: options.VpcEgressSetting | ResetValue;