GlobalOptions interface

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

Firma:

export interface GlobalOptions 

Proprietà

Proprietà Tipo Descrizione
concorrenza numero | Espressione <numero> | ResetValore Numero di richieste che una funzione può soddisfare contemporaneamente.
processore numero | "gcf_gen1" Numero frazionario di CPU da allocare a una funzione.
imporreAppCheck booleano Determina se Firebase App Check viene applicato. Il valore predefinito è falso.
inputSettings Impostazione Ingresso | ResetValore Impostazioni di ingresso che controllano da dove può essere chiamata 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 che possono essere eseguite in parallelo.
memoria Opzione memoria | 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.
preservareExternalChanges booleano Controlla se la configurazione della funzione modificata all'esterno dell'origine della funzione viene mantenuta. Il valore predefinito è falso.
regione Regione supportata | stringa | Espressione <stringa> | ResetValore Regione in cui devono essere distribuite le funzioni.
segreti (string | SecretParam)[]
serviceAccount stringa | Espressione <stringa> | ResetValore Account di servizio specifico per l'esecuzione della funzione.
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 Connetti una funzione a un connettore VPC specificato.
vpcConnectorEgressSettings Impostazione VpcEgress | ResetValore Impostazioni di uscita per il connettore VPC.

GlobalOptions.concurrency

Numero di richieste che una funzione può soddisfare contemporaneamente.

Può essere applicato solo alle funzioni in esecuzione su Cloud Functions (2a generazione)). Un valore null ripristina la concorrenza predefinita (80 quando CPU > = 1, 1 altrimenti). La concorrenza non può essere impostata su un valore diverso da 1 se cpu è inferiore a 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 dall'importo fisso assegnato in Cloud Functions (1a generazione). Per ripristinare le quantità di CPU utilizzate in gcloud o in Cloud Functions (1a generazione), impostalo sul valore "gcf_gen1"

Firma:

cpu?: number | "gcf_gen1";

GlobalOptions.enforceAppCheck

Determina se Firebase App Check viene applicato. Il valore predefinito è falso.

Quando è 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 undefined .

Firma:

enforceAppCheck?: boolean;

GlobalOptions.ingressSettings

Impostazioni di ingresso che controllano da dove può essere chiamata 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 che possono essere eseguite in parallelo.

Firma:

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

GlobalOptions.memory

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.

Alle istanze viene fatturata 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 mantenuta. Il valore predefinito è falso.

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

Firma:

preserveExternalChanges?: boolean;

GlobalOptions.region

Regione in cui devono essere distribuite le funzioni.

Firma:

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

GlobalOptions.secrets

Firma:

secrets?: (string | SecretParam)[];

GlobalOptions.serviceAccount

Account di servizio specifico per l'esecuzione della funzione.

Firma:

serviceAccount?: string | Expression<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 di seconda generazione è 1 s. Il timeout massimo per una funzione dipende dal tipo di funzione: le funzioni di gestione degli eventi hanno un timeout massimo di 540 s (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 (30 minuti).

Firma:

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

GlobalOptions.vpcConnector

Connetti una funzione a un connettore VPC specificato.

Firma:

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

GlobalOptions.vpcConnectorEgressSettings

Impostazioni di uscita per il connettore VPC.

Firma:

vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;