GlobalOptions to opcje, które można ustawić w całym projekcie. Te opcje są typowe dla protokołu HTTPS i funkcji obsługi zdarzeń.
Podpis:
export interface GlobalOptions
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. |
| procesory | liczba | „gcf_gen1” | Ułamkowa liczba procesorów, które mają zostać przydzielone do funkcji. |
| enforceAppCheck | wartość logiczna | Określa, czy egzekwowane jest Sprawdzanie aplikacji Firebase. Wartość domyślna to fałsz. |
| Ustawienia ruchu przychodzącego | Ustawienia ruchu przychodzącego | 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 mogą działać równolegle. |
| memory | 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. |
| preserveExternalChanges | wartość logiczna | Określa, czy konfiguracja funkcji zmodyfikowana poza źródłem funkcji jest zachowywana. Wartość domyślna to fałsz. |
| region [region] | supportedRegion | ciąg znaków | Wyrażenie<ciąg> | Resetuj wartość | Region, w którym powinny być wdrożone funkcje. |
| 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ę z określonym oprogramowaniem sprzęgającym VPC. |
| vpcConnectorEgressSettings, | VpcEgressSettings | Resetuj wartość | Ustawienia ruchu wychodzącego dla oprogramowania sprzęgającego VPC. |
GlobalOptions.concurrency
Liczba żądań, które funkcja może obsłużyć jednocześnie.
Można ją stosować tylko do funkcji działających w Cloud Functions (2 generacji). 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;
GlobalOptions.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 oraz od stałej liczby przypisanej w Cloud Functions (1 generacji). Aby przywrócić liczbę procesorów używaną w gcloud lub w Cloud Functions (1 generacji), ustaw wartość „gcf_gen1”
Podpis:
cpu?: number | "gcf_gen1";
GlobalOptions.enforceAppCheck
Określa, czy egzekwowane jest Sprawdzanie aplikacji Firebase. Wartość domyślna to fałsz.
Jeśli ma wartość Prawda, żądania z nieprawidłowymi tokenami automatycznie odpowiadają o błędzie 401 (Brak autoryzacji). Jeśli ma wartość Fałsz, żądania z nieprawidłowymi tokenami mają wartość event.app na undefined.
Podpis:
enforceAppCheck?: boolean;
GlobalOptions.ingressSettings
Ustawienia ruchu przychodzącego, które określają, skąd można wywoływać tę funkcję.
Podpis:
ingressSettings?: IngressSetting | ResetValue;
GlobalOptions.invoker
Wywołujący do ustawiania kontroli dostępu do funkcji HTTPS.
Podpis:
invoker?: "public" | "private" | string | string[];
GlobalOptions.labels (Opcje globalne).
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;
GlobalOptions.memory
Ilość pamięci, która ma zostać przydzielona do funkcji.
Podpis:
memory?: MemoryOption | Expression<number> | ResetValue;
GlobalOptions.minInstances
Minimalna liczba rzeczywistych instancji uruchomionych w danym momencie.
Opłaty za instancje są naliczane za przydział pamięci i 10% przydziału procesora w czasie bezczynności.
Podpis:
minInstances?: number | Expression<number> | ResetValue;
Opcje globalne.pomiń
Jeśli wartość to prawda, nie wdrażaj ani nie emuluj tej funkcji.
Podpis:
omit?: boolean | Expression<boolean>;
GlobalOptions.preserveExternalChanges
Określa, czy konfiguracja funkcji zmodyfikowana poza źródłem funkcji jest zachowywana. Wartość domyślna to fałsz.
Gdy konfigurujesz konfigurację dostępną na platformie bazowej, która nie jest jeszcze dostępna w pakiecie SDK Firebase dla Cloud Functions, zalecamy ustawienie atrybutu preserveExternalChanges na true. W przeciwnym razie gdy Google udostępni nową wersję pakietu SDK z obsługą brakującej konfiguracji, ręcznie skonfigurowane ustawienie Twojej funkcji może zostać nieumyślnie wyczyszczone.
Podpis:
preserveExternalChanges?: boolean;
GlobalOptions.region
Region, w którym powinny być wdrożone funkcje.
Podpis:
region?: SupportedRegion | string | Expression<string> | ResetValue;
GlobalOptions.secrets
Podpis:
secrets?: (string | SecretParam)[];
GlobalOptions.serviceAccount
Określone konto usługi, jako którego funkcja ma być uruchamiana.
Podpis:
serviceAccount?: string | Expression<string> | ResetValue;
GlobalOptions.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). Maksymalny limit czasu funkcji kolejki zadań to 1800 s (30 minut).
Podpis:
timeoutSeconds?: number | Expression<number> | ResetValue;
GlobalOptions.vpcConnector
Połącz funkcję z określonym oprogramowaniem sprzęgającym VPC.
Podpis:
vpcConnector?: string | Expression<string> | ResetValue;
GlobalOptions.vpcConnectorEgressSettings
Ustawienia ruchu wychodzącego dla oprogramowania sprzęgającego VPC.
Podpis:
vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;