GlobalOptions interface

GlobalOptions sono opzioni che possono essere impostate su un intero progetto. Queste opzioni sono comuni alle funzioni HTTPS e di gestione degli eventi.

Firma:

export interface GlobalOptions 

Proprietà

Proprietà Tipo Descrizione
concorrenza numero | Espressione<numero> | ResetValore Numero di richieste che una funzione può servire contemporaneamente.
processore numero | "gcf_gen1" Numero frazionario di CPU da allocare a una funzione.
imporreAppCheck booleano Determina se Firebase AppCheck è applicato. L'impostazione predefinita è false.
ingressSettings Impostazione ingresso | ResetValore Impostazioni di ingresso che controllano da dove è possibile chiamare questa funzione.
invocatore "pubblico" | "privato" | stringa | corda[] Invoker per impostare il controllo degli accessi sulle funzioni https.
etichette Registra<stringa, stringa> Etichette utente da impostare sulla funzione.
maxInstances numero | Espressione<numero> | ResetValore Numero massimo di istanze da eseguire in parallelo.
memoria MemoryOption | Espressione<numero> | ResetValore Quantità di memoria da allocare a una funzione.
minInstances numero | Espressione<numero> | ResetValore Numero minimo di istanze effettive da eseguire in un determinato momento.
omettere booleano | Espressione<booleano> Se vero, non distribuire o emulare questa funzione.
preserveExternalChanges booleano Controlla se la configurazione della funzione modificata all'esterno dell'origine della funzione viene conservata. L'impostazione predefinita è false.
regione Regione supportata | corda Regione in cui devono essere distribuite le funzioni.
segreti (stringa | SecretParam)[]
serviceAccount stringa | ResetValore Account di servizio specifico per la funzione da eseguire.
timeoutSecondi numero | Espressione<numero> | ResetValore Timeout per la funzione in secondi, i valori possibili sono compresi tra 0 e 540. Le funzioni HTTPS possono specificare un timeout più elevato.
vpcConnettore stringa | Espressione<stringa> | ResetValore Collega la funzione cloud al connettore VPC specificato.
vpcConnectorEgressSettings VpcEgressSetting | ResetValore Impostazioni di uscita per il connettore VPC.

GlobalOptions.concurrency

Numero di richieste che una funzione può servire contemporaneamente.

Può essere applicato solo alle funzioni in esecuzione su Cloud Functions v2. Un valore nullo ripristina la concorrenza predefinita (80 quando CPU > = 1, 1 altrimenti). La concorrenza non può essere impostata su un valore diverso da 1 se cpu è minore di 1. Il valore massimo per la concorrenza è 1.000.

Firma:

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

GlobalOptions.cpu

Numero frazionario di CPU da allocare a una funzione.

Il valore predefinito è 1 per le funzioni con < = 2 GB di RAM e aumenta per dimensioni di memoria maggiori. Questo è diverso dalle impostazioni predefinite quando si utilizza l'utilità gcloud ed è diverso dalla quantità fissa assegnata in Google Cloud Functions generazione 1. Per ripristinare le quantità di CPU utilizzate in gcloud o in Cloud Functions generazione 1, impostalo sul valore "gcf_gen1"

Firma:

cpu?: number | "gcf_gen1";

GlobalOptions.enforceAppCheck

Determina se Firebase AppCheck è applicato. L'impostazione predefinita è false.

Se vero, le richieste con token non validi rispondono automaticamente con un errore 401 (non autorizzato). Se false, le richieste con token non validi impostano event.app su undefiend.

Firma:

enforceAppCheck?: boolean;

GlobalOptions.ingressSettings

Impostazioni di ingresso che controllano da dove è possibile chiamare questa funzione.

Firma:

ingressSettings?: IngressSetting | ResetValue;

GlobalOptions.invoker

Invoker per impostare il controllo degli accessi sulle funzioni https.

Firma:

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

GlobalOptions.labels

Etichette utente da impostare sulla funzione.

Firma:

labels?: Record<string, string>;

GlobalOptions.maxInstances

Numero massimo di istanze da eseguire in parallelo.

Firma:

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

GlobalOptions.memoria

Quantità di memoria da allocare a una funzione.

Firma:

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

GlobalOptions.minInstances

Numero minimo di istanze effettive da eseguire in un determinato momento.

Le istanze verranno fatturate per l'allocazione della memoria e il 10% dell'allocazione della CPU mentre sono inattive.

Firma:

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

GlobalOptions.omit

Se vero, non distribuire o emulare questa funzione.

Firma:

omit?: boolean | Expression<boolean>;

GlobalOptions.preserveExternalChanges

Controlla se la configurazione della funzione modificata all'esterno dell'origine della funzione viene conservata. L'impostazione predefinita è false.

Quando si imposta la configurazione disponibile nella piattaforma sottostante che non è ancora disponibile nell'SDK di Firebase Functions, consigliamo vivamente di impostare preserveExternalChanges su true . In caso contrario, quando Firebase Functions SDK rilascia una nuova versione dell'SDK con supporto per la configurazione mancante, l'impostazione configurata manualmente della tua funzione potrebbe essere inavvertitamente cancellata.

Firma:

preserveExternalChanges?: boolean;

GlobalOptions.region

Regione in cui devono essere distribuite le funzioni.

Firma:

region?: SupportedRegion | string;

GlobalOptions.secrets

Firma:

secrets?: (string | SecretParam)[];

GlobalOptions.serviceAccount

Account di servizio specifico per la funzione da eseguire.

Firma:

serviceAccount?: string | ResetValue;

GlobalOptions.timeoutSeconds

Timeout per la funzione in secondi, i valori possibili sono compresi tra 0 e 540. Le funzioni HTTPS possono specificare un timeout più elevato.

Il timeout minimo per una funzione gen 2 è 1s. Il timeout massimo per una funzione dipende dal tipo di funzione: Le funzioni di gestione degli eventi hanno un timeout massimo di 540 secondi (9 minuti). HTTPS e le funzioni richiamabili hanno un timeout massimo di 36,00s (1 ora). Le funzioni della coda delle attività hanno un timeout massimo di 1.800 secondi (30 minuti)

Firma:

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

GlobalOptions.vpcConnector

Collega la funzione cloud al connettore VPC specificato.

Firma:

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

GlobalOptions.vpcConnectorEgressSettings

Impostazioni di uscita per il connettore VPC.

Firma:

vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;