GlobalOptions sind Optionen, die für ein gesamtes Projekt festgelegt werden können. Diese Optionen gelten für HTTPS- und Ereignisbehandlungsfunktionen.
Unterschrift:
export interface GlobalOptions
Eigenschaften
Eigentum | Typ | Beschreibung |
---|---|---|
Gleichzeitigkeit | Nummer | Ausdruck<Zahl> | Wert zurücksetzen | Anzahl der Anfragen, die eine Funktion gleichzeitig bedienen kann. |
Zentralprozessor | Nummer | "gcf_gen1" | Bruchzahl von CPUs, die einer Funktion zugewiesen werden sollen. |
AppCheck erzwingen | boolesch | Bestimmt, ob Firebase AppCheck erzwungen wird. Standardmäßig falsch. |
Eingangseinstellungen | Eingangseinstellung | Wert zurücksetzen | Ingress-Einstellungen, die steuern, von wo aus diese Funktion aufgerufen werden kann. |
Aufrufer | "öffentlich" | "privat" | Zeichenfolge | Zeichenfolge[] | Aufrufer zum Festlegen der Zugriffssteuerung für https-Funktionen. |
Etiketten | Datensatz<Zeichenfolge, Zeichenfolge> | Benutzerbezeichnungen, die für die Funktion festgelegt werden sollen. |
maxInstances | Nummer | Ausdruck<Zahl> | Wert zurücksetzen | Maximale Anzahl parallel ausgeführter Instanzen. |
Speicher | Speicheroption | Ausdruck<Zahl> | Wert zurücksetzen | Speichermenge, die einer Funktion zugewiesen werden soll. |
minInstanzen | Nummer | Ausdruck<Zahl> | Wert zurücksetzen | Mindestanzahl der tatsächlichen Instanzen, die zu einem bestimmten Zeitpunkt ausgeführt werden. |
auslassen | boolesch | Ausdruck<boolesch> | Falls wahr, stellen Sie diese Funktion nicht bereit oder emulieren Sie sie nicht. |
BewahreExterneÄnderungen auf | boolesch | Steuert, ob die außerhalb der Funktionsquelle geänderte Funktionskonfiguration beibehalten wird. Standardmäßig falsch. |
Region | Unterstützte Region | Schnur | Region, in der Funktionen bereitgestellt werden sollen. |
Geheimnisse | (Zeichenfolge | SecretParam)[] | |
Dienstkonto | Zeichenfolge | Wert zurücksetzen | Spezifisches Dienstkonto, unter dem die Funktion ausgeführt werden soll. |
timeoutSekunden | Zahl | Ausdruck<Zahl> | 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 angeben. |
vpcConnector | Zeichenfolge | Ausdruck<Zeichenfolge> | Wert zurücksetzen | Verbinden Sie die Cloud-Funktion mit dem angegebenen VPC-Connector. |
vpcConnectorEgressSettings | VpcEgressSetting | Wert zurücksetzen | Egress-Einstellungen 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 v2 ausgeführt werden. Ein Wert von null stellt die Standardparallelität wieder her (80, wenn CPU > = 1, sonst 1). Concurrency kann nicht auf einen anderen Wert als 1 gesetzt werden, wenn cpu
kleiner als 1 ist. Der maximale Wert für Concurrency ist 1.000.
Unterschrift:
concurrency?: number | Expression<number> | ResetValue;
GlobalOptions.cpu
Bruchzahl von CPUs, die einer Funktion zugewiesen werden sollen.
Standardmäßig 1 für Funktionen mit < = 2 GB RAM und erhöht sich für größere Speichergrößen. Dies unterscheidet sich von den Standardwerten bei Verwendung des gcloud-Dienstprogramms und von der in Google Cloud Functions-Generation 1 zugewiesenen festen Menge. Um zu den CPU-Mengen zurückzukehren, die in gcloud oder in Cloud Functions-Generation 1 verwendet werden, setzen Sie dies auf den Wert „gcf_gen1“.
Unterschrift:
cpu?: number | "gcf_gen1";
GlobalOptions.enforceAppCheck
Bestimmt, ob Firebase AppCheck erzwungen wird. Standardmäßig falsch.
Wenn wahr, antworten Anfragen mit ungültigen Token automatisch mit einem 401-Fehler (nicht autorisiert). Bei „false“ setzen Anfragen mit ungültigen Token event.app auf „undefiend“.
Unterschrift:
enforceAppCheck?: boolean;
GlobalOptions.ingressSettings
Ingress-Einstellungen, die steuern, von wo aus diese Funktion aufgerufen werden kann.
Unterschrift:
ingressSettings?: IngressSetting | ResetValue;
GlobalOptions.invoker
Aufrufer zum Festlegen der Zugriffssteuerung 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 parallel ausgeführter Instanzen.
Unterschrift:
maxInstances?: number | Expression<number> | ResetValue;
GlobalOptions.memory
Speichermenge, die einer Funktion zugewiesen werden soll.
Unterschrift:
memory?: MemoryOption | Expression<number> | ResetValue;
GlobalOptions.minInstanzen
Mindestanzahl der tatsächlichen Instanzen, die zu einem bestimmten Zeitpunkt ausgeführt werden.
Instanzen werden für die Speicherzuweisung und 10 % der CPU-Zuweisung im Leerlauf in Rechnung gestellt.
Unterschrift:
minInstances?: number | Expression<number> | ResetValue;
GlobalOptions.omit
Falls wahr, stellen Sie diese Funktion nicht bereit oder emulieren Sie sie nicht.
Unterschrift:
omit?: boolean | Expression<boolean>;
GlobalOptions.preserveExternalChanges
Steuert, ob die außerhalb der Funktionsquelle geänderte Funktionskonfiguration beibehalten wird. Standardmäßig falsch.
Wenn Sie die in der zugrunde liegenden Plattform verfügbare Konfiguration festlegen, die noch nicht im Firebase Functions SDK verfügbar ist, empfehlen wir dringend, preserveExternalChanges
auf true
zu setzen . Andernfalls, wenn das Firebase Functions SDK eine neue Version des SDK mit Unterstützung für die fehlende Konfiguration veröffentlicht, kann die manuell konfigurierte Einstellung Ihrer Funktion versehentlich gelöscht werden.
Unterschrift:
preserveExternalChanges?: boolean;
GlobalOptions.region
Region, in der Funktionen bereitgestellt werden sollen.
Unterschrift:
region?: SupportedRegion | string;
GlobalOptions.secrets
Unterschrift:
secrets?: (string | SecretParam)[];
GlobalOptions.serviceAccount
Spezifisches Dienstkonto, unter dem die Funktion ausgeführt werden soll.
Unterschrift:
serviceAccount?: 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 angeben.
Das minimale Timeout für eine Gen 2-Funktion beträgt 1 s. Das maximale Timeout für eine Funktion hängt von der Art der Funktion ab: Ereignisbehandlungsfunktionen 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 die Cloud-Funktion mit dem angegebenen VPC-Connector.
Unterschrift:
vpcConnector?: string | Expression<string> | ResetValue;
GlobalOptions.vpcConnectorEgressSettings
Egress-Einstellungen für den VPC-Connector.
Unterschrift:
vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;