GlobalOptions interface

GlobalOptions to opcje, które można ustawić w całym projekcie. Opcje te są wspólne dla funkcji HTTPS i obsługi zdarzeń.

Podpis:

export interface GlobalOptions 

Nieruchomości

GlobalOptions.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 (2. generacji)). 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;

GlobalOptions.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 wartości domyślnych podczas korzystania z narzędzia gcloud i różni się od stałej kwoty przypisanej w Cloud Functions (1. generacji). Aby powrócić do ilości procesora używanej w gcloud lub Cloud Functions (1. generacji), ustaw tę wartość na „gcf_gen1”

Podpis:

cpu?: number | "gcf_gen1";

GlobalOptions.enforceAppCheck

Określa, czy wymuszana jest kontrola aplikacji Firebase. Domyślnie jest to fałsz.

Jeśli ma wartość true, żądania z nieprawidłowymi tokenami automatycznie odpowiadają błędem 401 (nieautoryzowany). Jeśli wartość false, żądania z nieprawidłowymi tokenami ustawiają event.app na undefined .

Podpis:

enforceAppCheck?: boolean;

GlobalOptions.ingressSettings

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

Podpis:

ingressSettings?: IngressSetting | ResetValue;

GlobalOptions.invoker

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

Podpis:

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

Etykiety GlobalOptions

Etykiety użytkownika do ustawienia dla funkcji.

Podpis:

labels?: Record<string, string>;

GlobalOptions.maxInstances

Maksymalna liczba instancji, które mogą działać równolegle.

Podpis:

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

Opcje globalne.pamięć

Ilość pamięci do przydzielenia dla funkcji.

Podpis:

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

GlobalOptions.minInstances

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

Opłaty za instancje są rozliczane za alokację pamięci i 10% alokacji procesora w stanie bezczynności.

Podpis:

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

Opcje globalne.pomiń

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

Podpis:

omit?: boolean | Expression<boolean>;

GlobalOptions.preserveExternalChanges

Kontroluje, czy zachowywana jest konfiguracja funkcji zmodyfikowana poza źródłem funkcji. Domyślnie jest to fałsz.

W przypadku ustawiania konfiguracji dostępnej na podstawowej platformie, która nie jest jeszcze dostępna w pakiecie Firebase SDK dla Cloud Functions, zalecamy ustawienie preserveExternalChanges na true . W przeciwnym razie, gdy Google udostępni nową wersję pakietu SDK obsługującą brakującą konfigurację, ręcznie skonfigurowane ustawienia Twojej funkcji mogą zostać przypadkowo usunięte.

Podpis:

preserveExternalChanges?: boolean;

Opcje globalne.region

Region, w którym należy wdrożyć funkcje.

Podpis:

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

Opcje globalne.sekrety

Podpis:

secrets?: (string | SecretParam)[];

Konto GlobalOptions.service

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

Podpis:

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

GlobalOptions.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 drugiej generacji 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;

GlobalOptions.vpcConnector

Podłącz funkcję do określonego złącza VPC.

Podpis:

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

GlobalOptions.vpcConnectorEgressSettings

Ustawienia wyjścia dla łącznika VPC.

Podpis:

vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;