https.HttpsOptions interface

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

Podpis:

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

Rozszerza: pomiń<GlobalOptions, "region">

Właściwości

Właściwość Typ Opis
równoczesność liczba | Wyrażenie<liczba> | Resetuj wartość Liczba żądań, które funkcja może obsłużyć jednocześnie.
kody ciąg znaków | boolean | Wyrażenie regularne | Tablica<ciąg | Wyrażenie regularne Jeśli wartość to prawda, zezwala na CORS w żądaniach kierowanych do tej funkcji. Jeśli to string lub RegExp, zezwala na żądania z domen, które pasują do podanej wartości. Jeśli to Array, zezwala na żądania z domen pasujące do co najmniej 1 wpisu w tablicy. Wartość domyślna to „true” w przypadku https.CallableFunction, a w przeciwnym razie ma wartość „false”.
procesory liczba | „gcf_gen1” Ułamkowa liczba procesorów, które mają zostać przydzielone do funkcji.
Ustawienia ruchu przychodzącego options.IngressSettings | Resetuj wartość Ustawienia ruchu przychodzącego, które określają, skąd można wywoływać tę funkcję.
wywołujący „public” | „prywatny” | ciąg znaków | ciąg znaków[] Wywołujący do ustawiania kontroli dostępu do funkcji https.
etykiety Rekord<ciąg, ciąg> Etykiety użytkownika do ustawienia dla funkcji.
maxInstances liczba | Wyrażenie<liczba> | Resetuj wartość Maksymalna liczba instancji, które mają działać równolegle.
memory options.MemoryOption | Wyrażenie<liczba> | Resetuj wartość Ilość pamięci, która ma zostać przydzielona do funkcji.
Liczba instancji min. liczba | Wyrażenie<liczba> | Resetuj wartość Minimalna liczba rzeczywistych instancji uruchomionych w danym momencie.
pomiń boolean | Wyrażenie<wartość logiczna> Jeśli wartość to prawda, nie wdrażaj ani nie emuluj tej funkcji.
region [region] supportedRegion | ciąg znaków | Tablica<SupportedRegion | string> | Wyrażenie<ciąg> | Resetuj wartość Funkcje HTTP mogą zastępować opcje globalne i określać wiele regionów, w których nastąpi wdrożenie.
obiekty tajne (ciąg znaków | SecretParam)[]
serviceAccount ciąg znaków | Wyrażenie<ciąg> | Resetuj wartość Określone konto usługi, jako którego funkcja ma być uruchamiana.
timeoutSeconds, liczba | Wyrażenie<liczba> | Resetuj wartość Czas oczekiwania funkcji w sekundach. Możliwe wartości to od 0 do 540. Funkcje HTTPS mogą określać dłuższy czas oczekiwania.
Oprogramowanie sprzęgające VPC ciąg znaków | Wyrażenie<ciąg> | Resetuj wartość Połącz funkcję w Cloud Functions z określonym oprogramowaniem sprzęgającym VPC.
vpcConnectorEgressSettings, options.VpcEgressSetting | Resetuj wartość Ustawienia ruchu wychodzącego dla oprogramowania sprzęgającego VPC.

https.HttpsOptions.concurrency

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

Można go stosować tylko do funkcji działających w Cloud Functions w wersji 2. Wartość null przywraca domyślną równoczesność (80, gdy procesor >= 1, w przeciwnym razie 1). Równoczesność nie może mieć żadnej wartości innej niż 1, jeśli cpu ma wartość mniejszą niż 1. Maksymalna wartość równoczesności to 1000.

Podpis:

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

https.HttpsOptions.cors

Jeśli wartość to prawda, zezwala na CORS w żądaniach kierowanych do tej funkcji. Jeśli to string lub RegExp, zezwala na żądania z domen, które pasują do podanej wartości. Jeśli to Array, zezwala na żądania z domen pasujące do co najmniej 1 wpisu tablicy. Wartość domyślna to „true” w przypadku https.CallableFunction, a w przeciwnym razie ma wartość „false”.

Podpis:

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

https.HttpsOptions.cpu

Ułamkowa liczba procesorów, które mają zostać przydzielone do funkcji.

Domyślna wartość to 1 w przypadku funkcji z = 2 GB pamięci RAM. Zwiększa się, aby zwiększyć rozmiar pamięci. Ta wartość różni się od wartości domyślnych w przypadku korzystania z narzędzia gcloud i różni się od ustalonej wartości przypisanej w Google Cloud Functions generacji 1. Aby przywrócić liczbę procesorów używaną w gcloud lub w Cloud Functions generacji 1, ustaw wartość „gcf_gen1”

Podpis:

cpu?: number | "gcf_gen1";

https.HttpsOptions.ingressSettings

Ustawienia ruchu przychodzącego, które określają, skąd można wywoływać tę funkcję.

Podpis:

ingressSettings?: options.IngressSetting | ResetValue;

https.HttpsOptions.invoker

Wywołujący do ustawiania kontroli 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, które mają działać równolegle.

Podpis:

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

https.HttpsOptions.memory

Ilość pamięci, która ma zostać przydzielona do funkcji.

Podpis:

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

https.HttpsOptions.minInstances

Minimalna liczba rzeczywistych instancji uruchomionych w danym momencie.

Podczas bezczynności instancje będą obciążane opłatami za przydział pamięci i 10% przydziału procesora.

Podpis:

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

https.HttpsOptions.omit

Jeśli wartość to prawda, nie wdrażaj ani nie emuluj tej funkcji.

Podpis:

omit?: boolean | Expression<boolean>;

https.HttpsOptions.region

Funkcje HTTP mogą zastępować opcje globalne i określać wiele regionów, w których nastąpi wdrożenie.

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, jako którego funkcja ma być uruchamiana.

Podpis:

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

https.HttpsOptions.timeoutSeconds

Czas oczekiwania funkcji w sekundach. Możliwe wartości to od 0 do 540. Funkcje HTTPS mogą określać dłuższy czas oczekiwania.

Minimalny czas oczekiwania funkcji 2 generacji to 1 s. Maksymalny czas oczekiwania funkcji zależy od typu funkcji. Funkcje obsługi zdarzeń mają maksymalny limit czasu wynoszący 540 s (9 minut). Funkcje HTTPS i możliwe do wywołania funkcje mają maksymalny limit czasu wynoszący 36 000 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ę w Cloud Functions z określonym oprogramowaniem sprzęgającym VPC.

Podpis:

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

https.HttpsOptions.vpcConnectorEgressSettings

Ustawienia ruchu wychodzącego dla oprogramowania sprzęgającego VPC.

Podpis:

vpcConnectorEgressSettings?: options.VpcEgressSetting | ResetValue;