https.HttpsOptions interface

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

Signature:

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

Extension : Omettre < GlobalOptions , "région">

Propriétés

Propriété Taper Description
concurrence numéro | Expression <numéro> | Réinitialiser la valeur Nombre de requêtes qu'une fonction peut traiter en même temps.
cors chaîne | booléen | RegExp | Tableau<string | ExpExp> 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. La valeur par défaut est true pour https.CallableFunction et false sinon.
CPU numéro | "gcf_gen1" Nombre fractionnaire de processeurs à allouer à une fonction.
paramètres d'entrée options.IngressSetting | Réinitialiser la valeur Paramètres d'entrée qui contrôlent d'où cette fonction peut être appelée.
invocateur "publique" | "privé" | chaîne | chaîne[] Invocateur pour définir le contrôle d’accès sur les fonctions https.
Étiquettes Enregistrer<string, string> Libellés utilisateur à définir sur la fonction.
maxInstances numéro | Expression <numéro> | Réinitialiser la valeur Nombre maximum d'instances à exécuter en parallèle.
mémoire options.MemoryOption | Expression <numéro> | Réinitialiser la valeur Quantité de mémoire à allouer à une fonction.
minInstances numéro | Expression <numéro> | Réinitialiser la valeur Nombre minimum d'instances réelles à exécuter à un moment donné.
omettre booléen | Expression <booléen> Si c’est vrai, ne déployez pas et n’émulez pas cette fonction.
région Région prise en charge | chaîne | Tableau< SupportedRegion | chaîne> | Expression <chaîne> | Réinitialiser la valeur Les fonctions HTTP peuvent remplacer les options globales et spécifier plusieurs régions dans lesquelles déployer.
secrets (chaîne | SecretParam)[]
compte de service chaîne | Expression <chaîne> | Réinitialiser la valeur Compte de service spécifique sous lequel la fonction doit être exécutée.
timeoutSecondes numéro | Expression <numéro> | Réinitialiser la valeur 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é.
vpcConnecteur chaîne | Expression <chaîne> | Réinitialiser la valeur Connectez la fonction cloud au connecteur VPC spécifié.
vpcConnectorEgressSettings options.VpcEgressSetting | Réinitialiser la valeur Paramètres de sortie pour le connecteur VPC.

https.HttpsOptions.concurrency

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

Ne peut être appliqué qu'aux fonctions exécutées sur Cloud Functions v2. 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;

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. La valeur par défaut est true pour https.CallableFunction et false sinon.

Signature:

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

https.HttpsOptions.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 la génération 1 de Google Cloud Functions. Pour revenir aux quantités de processeur utilisées dans gcloud ou dans la génération 1 de Cloud Functions, définissez-la 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

Invocateur 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 maximum 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 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;

https.HttpsOptions.omit

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

Signature:

omit?: boolean | Expression<boolean>;

https.HttpsOptions.region

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

Signature:

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

https.HttpsOptions.secrets

Signature:

secrets?: (string | SecretParam)[];

https.HttpsOptions.serviceAccount

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

Signature:

serviceAccount?: string | Expression<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 élevé.

Le délai d'attente minimum pour une fonction Gen 2 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;

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;