Opcje globalne to opcje, które można ustawić w całym projekcie. Te opcje są wspólne dla funkcji HTTPS i obsługi zdarzeń.
Podpis:
export interface GlobalOptions
Nieruchomości
| Nieruchomość | Typ | Opis |
|---|---|---|
| konkurencja | liczba | Wyrażenie<liczba> | Resetuj wartość | Liczba żądań, które funkcja może obsłużyć jednocześnie. |
| procesor | liczba | "gcf_gen1" | Ułamkowa liczba procesorów do przydzielenia funkcji. |
| wymuszaj kontrolę aplikacji | logiczna | Określa, czy Firebase AppCheck jest wymuszany. Domyślnie fałsz. |
| Ustawienia ruchu przychodzącego | Ustawienia ruchu przychodzącego | Resetuj 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 do ustawiania kontroli dostępu do funkcji https. |
| etykiety | Rekord<łańcuch, ciąg> | Etykiety użytkownika do ustawienia dla funkcji. |
| maxInstancje | liczba | Wyrażenie<liczba> | Resetuj wartość | Maksymalna liczba instancji działających równolegle. |
| pamięć | Opcja pamięci | Wyrażenie<liczba> | Resetuj wartość | Ilość pamięci do przydzielenia funkcji. |
| minInstancje | liczba | Wyrażenie<liczba> | Resetuj wartość | Minimalna liczba rzeczywistych instancji, które mają być uruchomione w danym czasie. |
| pomijać | wartość logiczna | Wyrażenie<wartość logiczna> | Jeśli to prawda, nie wdrażaj ani nie emuluj tej funkcji. |
| zachowaj zmiany zewnętrzne | logiczna | Kontroluje, czy konfiguracja funkcji zmodyfikowana poza źródłem funkcji jest zachowywana. Domyślnie fałsz. |
| region | Obsługiwany region | strunowy | Region, w którym należy wdrożyć funkcje. |
| tajniki | (string | SecretParam)[] | |
| konto usługi | ciąg | Resetuj wartość | Określone konto usługi, w którym funkcja ma być uruchamiana. |
| limit czasu Sekundy | liczba | Wyrażenie<liczba> | Resetuj wartość | Limit czasu dla funkcji w sekundach, możliwe wartości to od 0 do 540. Funkcje HTTPS mogą określać wyższy limit czasu. |
| vpcConnector | ciąg | Wyrażenie<łańcuch> | Resetuj wartość | Połącz funkcję chmury z określonym łącznikiem VPC. |
| vpcConnectorEgressSettings | VpcEgressSetting | Resetuj wartość | Ustawienia ruchu wychodzącego dla łącznika VPC. |
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 v2. Wartość null przywraca domyślną współbieżność (80, gdy CPU > = 1, inaczej 1). Współbieżności nie można ustawić na inną wartość niż 1, jeśli cpu jest mniejsza niż 1. Maksymalna wartość współbieżności to 1000.
Podpis:
concurrency?: number | Expression<number> | ResetValue;
GlobalOptions.cpu
Ułamkowa liczba procesorów do przydzielenia funkcji.
Domyślnie 1 dla funkcji z < = 2 GB pamięci 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 Google Cloud Functions 1. generacji. Aby przywrócić liczbę procesorów używaną w gcloud lub Cloud Functions 1. generacji, ustaw tę wartość na „gcf_gen1”
Podpis:
cpu?: number | "gcf_gen1";
GlobalOptions.enforceAppCheck
Określa, czy Firebase AppCheck jest wymuszany. Domyślnie fałsz.
W przypadku wartości true żądania z nieprawidłowymi tokenami automatycznie odpowiadają z błędem 401 (brak autoryzacji). W przypadku wartości false żądania z nieprawidłowymi tokenami ustawiają event.app na undefiend.
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 do ustawiania kontroli dostępu do funkcji https.
Podpis:
invoker?: "public" | "private" | string | string[];
GlobalOptions.etykiety
Etykiety użytkownika do ustawienia dla funkcji.
Podpis:
labels?: Record<string, string>;
GlobalOptions.maxInstances
Maksymalna liczba instancji działających równolegle.
Podpis:
maxInstances?: number | Expression<number> | ResetValue;
GlobalOptions.pamięć
Ilość pamięci do przydzielenia funkcji.
Podpis:
memory?: MemoryOption | Expression<number> | ResetValue;
GlobalOptions.minInstances
Minimalna liczba rzeczywistych instancji, które mają być uruchomione w danym czasie.
Instancje będą rozliczane za alokację pamięci i 10% alokacji procesora w czasie bezczynności.
Podpis:
minInstances?: number | Expression<number> | ResetValue;
GlobalOptions. pomiń
Jeśli to prawda, nie wdrażaj ani nie emuluj tej funkcji.
Podpis:
omit?: boolean | Expression<boolean>;
GlobalOptions.preserveExternalChanges
Kontroluje, czy konfiguracja funkcji zmodyfikowana poza źródłem funkcji jest zachowywana. Domyślnie fałsz.
W przypadku ustawiania konfiguracji dostępnej na podstawowej platformie, która nie jest jeszcze dostępna w pakiecie Firebase Functions SDK, zdecydowanie zalecamy ustawienie parametru preserveExternalChanges na true . W przeciwnym razie, gdy pakiet Firebase Functions SDK opublikuje nową wersję pakietu SDK obsługującą brakującą konfigurację, ręcznie skonfigurowane ustawienie funkcji może zostać przypadkowo usunięte.
Podpis:
preserveExternalChanges?: boolean;
GlobalOptions.region
Region, w którym należy wdrożyć funkcje.
Podpis:
region?: SupportedRegion | string;
Sekrety opcji globalnych
Podpis:
secrets?: (string | SecretParam)[];
GlobalOptions.serviceAccount
Określone konto usługi, w którym funkcja ma być uruchamiana.
Podpis:
serviceAccount?: string | ResetValue;
GlobalOptions.timeoutSeconds
Limit czasu dla funkcji w sekundach, możliwe wartości to od 0 do 540. Funkcje HTTPS mogą określać wyższy limit czasu.
Minimalny limit czasu dla funkcji Gen 2 to 1s. Maksymalny limit czasu dla funkcji zależy od typu funkcji: Funkcje obsługi zdarzeń mają maksymalny limit czasu wynoszący 540 s (9 minut). Funkcje HTTPS i wywoływalne mają maksymalny limit czasu 36,00s (1 godzina). Funkcje kolejki zadań mają maksymalny limit czasu 1800 s (30 minut)
Podpis:
timeoutSeconds?: number | Expression<number> | ResetValue;
GlobalOptions.vpcConnector
Połącz funkcję chmury z określonym łącznikiem VPC.
Podpis:
vpcConnector?: string | Expression<string> | ResetValue;
GlobalOptions.vpcConnectorEgressSettings
Ustawienia ruchu wychodzącego dla łącznika VPC.
Podpis:
vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;