GlobalOptions sind Optionen, die für ein gesamtes Projekt festgelegt werden können. Diese Optionen gelten für HTTPS- und Ereignisverarbeitungsfunktionen.
Unterschrift:
export interface GlobalOptions
Eigenschaften
| Eigentum | Typ | Beschreibung |
|---|---|---|
| Parallelität | Nummer | Ausdruck <Nummer> | Wert zurücksetzen | Anzahl der Anfragen, die eine Funktion gleichzeitig bedienen kann. |
| CPU | Nummer | „gcf_gen1“ | Bruchzahl der CPUs, die einer Funktion zugewiesen werden sollen. |
| erzwingeAppCheck | Boolescher Wert | Bestimmt, ob Firebase App Check erzwungen wird. Der Standardwert ist „false“. |
| IngressSettings | IngressSetting | Wert zurücksetzen | Eingangseinstellungen, die steuern, von wo aus diese Funktion aufgerufen werden kann. |
| Anrufer | „öffentlich“ | „privat“ | Zeichenfolge | string[] | Aufrufer zum Festlegen der Zugriffskontrolle für HTTPS-Funktionen. |
| Etiketten | Record<string, string> | Benutzerbezeichnungen, die für die Funktion festgelegt werden sollen. |
| maxInstances | Nummer | Ausdruck <Nummer> | Wert zurücksetzen | Maximale Anzahl von Instanzen, die parallel ausgeführt werden können. |
| Erinnerung | Speicheroption | Ausdruck <Nummer> | Wert zurücksetzen | Speichermenge, die einer Funktion zugewiesen werden soll. |
| minInstanzen | Nummer | Ausdruck <Nummer> | Wert zurücksetzen | Mindestanzahl tatsächlicher Instanzen, die zu einem bestimmten Zeitpunkt ausgeführt werden sollen. |
| auslassen | boolescher Wert | Ausdruck <boolean> | Wenn „true“, diese Funktion nicht bereitstellen oder emulieren. |
| PreserveExternalChanges | Boolescher Wert | Steuert, ob die außerhalb der Funktionsquelle geänderte Funktionskonfiguration erhalten bleibt. Der Standardwert ist „false“. |
| Region | UnterstützteRegion | Zeichenfolge | Ausdruck <string> | Wert zurücksetzen | Region, in der Funktionen bereitgestellt werden sollen. |
| Geheimnisse | (string | SecretParam)[] | |
| serviceAccount | Zeichenfolge | Ausdruck <string> | Wert zurücksetzen | Spezifisches Dienstkonto, unter dem die Funktion ausgeführt werden soll. |
| timeoutSekunden | Nummer | Ausdruck <Nummer> | Wert zurücksetzen | Timeout für die Funktion in Sekunden, mögliche Werte sind 0 bis 540. HTTPS-Funktionen können einen höheren Timeout festlegen. |
| vpcConnector | Zeichenfolge | Ausdruck <string> | Wert zurücksetzen | Verbinden Sie eine Funktion mit einem angegebenen VPC-Connector. |
| vpcConnectorEgressSettings | VpcEgressSetting | Wert zurücksetzen | Ausgangseinstellungen für den VPC-Connector. |
GlobalOptions.concurrency
Anzahl der Anfragen, die eine Funktion gleichzeitig bedienen kann.
Kann nur auf Funktionen angewendet werden, die auf Cloud Functions (2. Generation) ausgeführt werden. Ein Wert von Null stellt die Standard-Parallelität wieder her (80, wenn CPU > = 1, sonst 1). Die Parallelität kann nicht auf einen anderen Wert als 1 festgelegt werden, wenn cpu kleiner als 1 ist. Der Maximalwert für die Parallelität beträgt 1.000.
Unterschrift:
concurrency?: number | Expression<number> | ResetValue;
GlobalOptions.cpu
Bruchzahl der CPUs, die einer Funktion zugewiesen werden sollen.
Der Standardwert ist 1 für Funktionen mit < = 2 GB RAM und erhöht sich bei größeren Speichergrößen. Dies unterscheidet sich von den Standardwerten bei Verwendung des Dienstprogramms gcloud und vom festen Betrag, der in Cloud Functions (1. Generation) zugewiesen wird. Um zu den in gcloud oder in Cloud Functions (1. Generation) verwendeten CPU-Mengen zurückzukehren, legen Sie diesen Wert auf „gcf_gen1“ fest.
Unterschrift:
cpu?: number | "gcf_gen1";
GlobalOptions.enforceAppCheck
Bestimmt, ob Firebase App Check erzwungen wird. Der Standardwert ist „false“.
Bei „true“ antworten Anfragen mit ungültigen Token automatisch mit dem Fehler 401 (nicht autorisiert). Bei „false“ setzen Anforderungen mit ungültigen Token event.app auf undefined .
Unterschrift:
enforceAppCheck?: boolean;
GlobalOptions.ingressSettings
Eingangseinstellungen, die steuern, von wo aus diese Funktion aufgerufen werden kann.
Unterschrift:
ingressSettings?: IngressSetting | ResetValue;
GlobalOptions.invoker
Aufrufer zum Festlegen der Zugriffskontrolle für HTTPS-Funktionen.
Unterschrift:
invoker?: "public" | "private" | string | string[];
GlobalOptions.labels
Benutzerbezeichnungen, die für die Funktion festgelegt werden sollen.
Unterschrift:
labels?: Record<string, string>;
GlobalOptions.maxInstances
Maximale Anzahl von Instanzen, die parallel ausgeführt werden können.
Unterschrift:
maxInstances?: number | Expression<number> | ResetValue;
GlobalOptions.memory
Speichermenge, die einer Funktion zugewiesen werden soll.
Unterschrift:
memory?: MemoryOption | Expression<number> | ResetValue;
GlobalOptions.minInstances
Mindestanzahl tatsächlicher Instanzen, die zu einem bestimmten Zeitpunkt ausgeführt werden sollen.
Instanzen werden für die Speicherzuteilung und 10 % der CPU-Zuteilung im Leerlauf in Rechnung gestellt.
Unterschrift:
minInstances?: number | Expression<number> | ResetValue;
GlobalOptions.omit
Wenn „true“, diese Funktion nicht bereitstellen oder emulieren.
Unterschrift:
omit?: boolean | Expression<boolean>;
GlobalOptions.preserveExternalChanges
Steuert, ob die außerhalb der Funktionsquelle geänderte Funktionskonfiguration erhalten bleibt. Der Standardwert ist „false“.
Wenn Sie die Konfiguration auf einer zugrunde liegenden Plattform festlegen, die noch nicht im Firebase SDK für Cloud Functions verfügbar ist, empfehlen wir, preserveExternalChanges “ auf true zu setzen . Andernfalls kann es passieren, dass die manuell konfigurierte Einstellung Ihrer Funktion unbeabsichtigt gelöscht wird, wenn Google eine neue Version des SDK mit Unterstützung für die fehlende Konfiguration veröffentlicht.
Unterschrift:
preserveExternalChanges?: boolean;
GlobalOptions.region
Region, in der Funktionen bereitgestellt werden sollen.
Unterschrift:
region?: SupportedRegion | string | Expression<string> | ResetValue;
GlobalOptions.secrets
Unterschrift:
secrets?: (string | SecretParam)[];
GlobalOptions.serviceAccount
Spezifisches Dienstkonto, unter dem die Funktion ausgeführt werden soll.
Unterschrift:
serviceAccount?: string | Expression<string> | ResetValue;
GlobalOptions.timeoutSeconds
Timeout für die Funktion in Sekunden, mögliche Werte sind 0 bis 540. HTTPS-Funktionen können einen höheren Timeout festlegen.
Die Mindestzeitüberschreitung für eine Funktion der 2. Generation beträgt 1 Sekunde. Das maximale Timeout für eine Funktion hängt von der Art der Funktion ab: Event-Handling-Funktionen haben ein maximales Timeout von 540 Sekunden (9 Minuten). HTTPS und aufrufbare Funktionen haben ein maximales Timeout von 36,00 Sekunden (1 Stunde). Aufgabenwarteschlangenfunktionen haben ein maximales Timeout von 1.800 Sekunden (30 Minuten).
Unterschrift:
timeoutSeconds?: number | Expression<number> | ResetValue;
GlobalOptions.vpcConnector
Verbinden Sie eine Funktion mit einem angegebenen VPC-Connector.
Unterschrift:
vpcConnector?: string | Expression<string> | ResetValue;
GlobalOptions.vpcConnectorEgressSettings
Ausgangseinstellungen für den VPC-Connector.
Unterschrift:
vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;