https.HttpsOptions interface

Optionen, die für eine onRequest-HTTPS-Funktion festgelegt werden können.

Unterschrift:

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

Erweitert: Weglassen< GlobalOptions , „Region“>

Eigenschaften

Eigentum Typ Beschreibung
Parallelität Nummer | Ausdruck <Nummer> | Wert zurücksetzen Anzahl der Anfragen, die eine Funktion gleichzeitig bedienen kann.
kors Zeichenfolge | boolescher Wert | RegExp | Array<string | RegExp> Wenn true, wird CORS bei Anfragen an diese Funktion zugelassen. Wenn es sich um eine string oder RegExp handelt, werden Anfragen von Domänen zugelassen, die dem angegebenen Wert entsprechen. Wenn es sich um ein Array handelt, werden Anfragen von Domänen zugelassen, die mit mindestens einem Eintrag des Arrays übereinstimmen. Der Standardwert ist „true“ für https.CallableFunction , andernfalls „false“.
CPU Nummer | „gcf_gen1“ Bruchzahl der CPUs, die einer Funktion zugewiesen werden sollen.
IngressSettings Optionen.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 parallel laufender Instanzen.
Erinnerung Optionen.MemoryOption | 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.
Region UnterstützteRegion | Zeichenfolge | Array< SupportedRegion | string> | Ausdruck <string> | Wert zurücksetzen HTTP-Funktionen können globale Optionen überschreiben und mehrere Regionen für die Bereitstellung angeben.
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 Cloud-Funktion mit dem angegebenen VPC-Connector verbinden.
vpcConnectorEgressSettings Optionen.VpcEgressSetting | Wert zurücksetzen Ausgangseinstellungen für den VPC-Connector.

https.HttpsOptions.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 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;

https.HttpsOptions.cors

Wenn true, wird CORS bei Anfragen an diese Funktion zugelassen. Wenn dies eine string oder RegExp ist , lässt Anfragen von Domänen zu, die dem angegebenen Wert entsprechen. Wenn dies ein Array ist , ermöglicht Anfragen von Domänen, die mit mindestens einem Eintrag des Arrays übereinstimmen. Der Standardwert ist „true“ für https.CallableFunction , andernfalls „false“.

Unterschrift:

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

https.HttpsOptions.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 Standardeinstellungen bei Verwendung des gcloud-Dienstprogramms und unterscheidet sich von der festen Menge, die in Google Cloud Functions Generation 1 zugewiesen wurde. Um zu den in gcloud oder in Cloud Functions Generation 1 verwendeten CPU-Mengen zurückzukehren, legen Sie dies auf den Wert „gcf_gen1“ fest.

Unterschrift:

cpu?: number | "gcf_gen1";

https.HttpsOptions.ingressSettings

Eingangseinstellungen, die steuern, von wo aus diese Funktion aufgerufen werden kann.

Unterschrift:

ingressSettings?: options.IngressSetting | ResetValue;

https.HttpsOptions.invoker

Aufrufer zum Festlegen der Zugriffskontrolle für https-Funktionen.

Unterschrift:

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

https.HttpsOptions.labels

Benutzerbezeichnungen, die für die Funktion festgelegt werden sollen.

Unterschrift:

labels?: Record<string, string>;

https.HttpsOptions.maxInstances

Maximale Anzahl parallel laufender Instanzen.

Unterschrift:

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

https.HttpsOptions.memory

Speichermenge, die einer Funktion zugewiesen werden soll.

Unterschrift:

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

https.HttpsOptions.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;

https.HttpsOptions.omit

Wenn „true“, diese Funktion nicht bereitstellen oder emulieren.

Unterschrift:

omit?: boolean | Expression<boolean>;

https.HttpsOptions.region

HTTP-Funktionen können globale Optionen überschreiben und mehrere Regionen für die Bereitstellung angeben.

Unterschrift:

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

https.HttpsOptions.secrets

Unterschrift:

secrets?: (string | SecretParam)[];

https.HttpsOptions.serviceAccount

Spezifisches Dienstkonto, unter dem die Funktion ausgeführt werden soll.

Unterschrift:

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

https.HttpsOptions.timeoutSeconds

Timeout für die Funktion in Sekunden, mögliche Werte sind 0 bis 540. HTTPS-Funktionen können einen höheren Timeout festlegen.

Das minimale Timeout für eine Gen-2-Funktion 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;

https.HttpsOptions.vpcConnector

Cloud-Funktion mit dem angegebenen VPC-Connector verbinden.

Unterschrift:

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

https.HttpsOptions.vpcConnectorEgressSettings

Ausgangseinstellungen für den VPC-Connector.

Unterschrift:

vpcConnectorEgressSettings?: options.VpcEgressSetting | ResetValue;