https.HttpsOptions interface

Opcje, które można ustawić w funkcji HTTPS onRequest.

Podpis:

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

Rozszerza: Pomiń < GlobalOptions , "region">

Nieruchomości

Nieruchomość Typ Opis
konkurencja numer | Wyrażenie <numer> | Zresetuj wartość Liczba żądań, które funkcja może obsłużyć jednocześnie.
kor ciąg | wartość logiczna | RegExp | Tablica<string | RegExp> Jeśli to prawda, zezwala CORS na żądania do tej funkcji. Jeśli jest to string lub RegExp , zezwala na żądania z domen pasujących do podanej wartości. Jeśli jest to Array , zezwala na żądania z domen pasujących do co najmniej jednego wpisu tablicy. Domyślnie true dla https.CallableFunction i false w przeciwnym razie.
procesor numer | „gcf_gen1” Ułamkowa liczba procesorów do przydzielenia do funkcji.
Ustawienia wejściowe Options.IngressSetting | Zresetuj wartość Ustawienia ruchu przychodzącego, które kontrolują, skąd można wywołać tę funkcję.
wywołujący „publiczny” | "prywatny" | ciąg | strunowy[] Invoker ustawiający kontrolę dostępu do funkcji https.
etykiety Rekord<ciąg, ciąg> Etykiety użytkownika do ustawienia dla funkcji.
maxInstancje numer | Wyrażenie <numer> | Zresetuj wartość Maksymalna liczba instancji działających równolegle.
pamięć opcje.Opcja pamięci | Wyrażenie <numer> | Zresetuj wartość Ilość pamięci do przydzielenia dla funkcji.
minInstancje numer | Wyrażenie <numer> | Zresetuj wartość Minimalna liczba rzeczywistych instancji, które mają być uruchomione w danym momencie.
pomijać wartość logiczna | Wyrażenie <wartość logiczna> Jeśli ma wartość true, nie wdrażaj ani nie emuluj tej funkcji.
region Obsługiwany region | ciąg | Tablica< Obsługiwany region | ciąg> | Wyrażenie <ciąg> | Zresetuj wartość Funkcje HTTP mogą zastąpić opcje globalne i określić wiele regionów do wdrożenia.
tajniki (ciąg | SecretParam)[]
konto serwisowe ciąg | Wyrażenie <ciąg> | Zresetuj wartość Określone konto usługi, na którym ma działać funkcja.
limit czasuSekundy numer | Wyrażenie <numer> | Zresetuj wartość Limit czasu dla funkcji w sekundach, możliwe wartości to 0 do 540. Funkcje HTTPS mogą określać wyższy limit czasu.
złącze vpc ciąg | Wyrażenie <ciąg> | Zresetuj wartość Połącz funkcję chmury z określonym złączem VPC.
Ustawienia vpcConnectorEgress Options.VpcEgressSetting | Zresetuj wartość Ustawienia wyjścia dla łącznika VPC.

https.HttpsOptions.concurrency

Liczba żądań, które funkcja może obsłużyć jednocześnie.

Można zastosować tylko do funkcji działających w Cloud Functions v2. Wartość null przywraca domyślną współbieżność (80, gdy procesor > = 1, 1 w innym przypadku). Współbieżności nie można ustawić na żadną wartość inną niż 1, jeśli cpu jest mniejszy niż 1. Maksymalna wartość współbieżności wynosi 1000.

Podpis:

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

https.HttpsOptions.cors

Jeśli to prawda, zezwala CORS na żądania do tej funkcji. Jeśli jest to string lub RegExp , zezwala na żądania z domen pasujących do podanej wartości. Jeśli jest to Array , umożliwia żądania z domen pasujących do co najmniej jednego wpisu w tablicy. Domyślnie true dla https.CallableFunction i false w przeciwnym razie.

Podpis:

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

https.HttpsOptions.cpu

Ułamkowa liczba procesorów do przydzielenia do funkcji.

Domyślnie 1 dla funkcji z < = 2 GB RAM i zwiększa się w przypadku większych rozmiarów pamięci. Różni się to od ustawień domyślnych podczas korzystania z narzędzia gcloud i różni się od stałej kwoty przypisanej w Google Cloud Functions generacji 1. Aby przywrócić wartości procesora używane w gcloud lub Cloud Functions generacji 1, ustaw tę wartość na „gcf_gen1”

Podpis:

cpu?: number | "gcf_gen1";

https.HttpsOptions.ingressSettings

Ustawienia ruchu przychodzącego, które kontrolują, skąd można wywołać tę funkcję.

Podpis:

ingressSettings?: options.IngressSetting | ResetValue;

https.HttpsOptions.invoker

Invoker ustawiający kontrolę dostępu do funkcji https.

Podpis:

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

https.HttpsOptions.labels

Etykiety użytkownika do ustawienia dla funkcji.

Podpis:

labels?: Record<string, string>;

https.HttpsOptions.maxInstances

Maksymalna liczba instancji działających równolegle.

Podpis:

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

https.HttpsOptions.memory

Ilość pamięci do przydzielenia dla funkcji.

Podpis:

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

https.HttpsOptions.minInstances

Minimalna liczba rzeczywistych instancji, które mają być uruchomione w danym momencie.

Instancje będą rozliczane za alokację pamięci i 10% alokacji procesora w stanie bezczynności.

Podpis:

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

https.HttpsOptions.pomiń

Jeśli ma wartość true, nie wdrażaj ani nie emuluj tej funkcji.

Podpis:

omit?: boolean | Expression<boolean>;

https.HttpsOptions.region

Funkcje HTTP mogą zastąpić opcje globalne i określić wiele regionów do wdrożenia.

Podpis:

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

https.HttpsOptions.secrets

Podpis:

secrets?: (string | SecretParam)[];

https.HttpsOptions.serviceAccount

Określone konto usługi, na którym ma działać funkcja.

Podpis:

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

https.HttpsOptions.timeoutSeconds

Limit czasu dla funkcji w sekundach, możliwe wartości to 0 do 540. Funkcje HTTPS mogą określać wyższy limit czasu.

Minimalny limit czasu dla funkcji gen. 2 wynosi 1 s. Maksymalny limit czasu dla funkcji zależy od typu funkcji: Maksymalny limit czasu funkcji obsługi zdarzeń wynosi 540 s (9 minut). Funkcje HTTPS i wywoływalne mają maksymalny limit czasu wynoszący 36,00 s (1 godzina). Funkcje kolejki zadań mają maksymalny limit czasu wynoszący 1800 s (30 minut)

Podpis:

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

https.HttpsOptions.vpcConnector

Połącz funkcję chmury z określonym złączem VPC.

Podpis:

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

https.HttpsOptions.vpcConnectorEgressSettings

Ustawienia wyjścia dla łącznika VPC.

Podpis:

vpcConnectorEgressSettings?: options.VpcEgressSetting | ResetValue;