RuntimeOptions interface

Opcje konfiguracji funkcji stosowanej w czasie działania.

Podpis:

export interface RuntimeOptions 

Właściwości

RuntimeOptions.consumeAppCheckToken

Określa, czy token Sprawdzania aplikacji Firebase jest wykorzystywany na żądanie. Wartość domyślna to fałsz.

Ustaw wartość „true”, aby włączyć ochronę przed ponownym odtwarzaniem Sprawdzania aplikacji przez wykorzystanie tokena Sprawdzania aplikacji w żądaniu z możliwością wywołania. W przypadku tokenów, które zostały już wykorzystane, właściwość request.app.alreadyConsumed ma wartość true (prawda).

Tokeny są zużywane tylko wtedy, gdy są wysyłane do usługi Sprawdzanie aplikacji przez ustawienie tej opcji na wartość Prawda. Nie jest on wykorzystywany w innych celach.

Ta funkcja ochrony przed ponownym odtwarzaniem wymaga dodatkowego wywołania sieciowego do backendu Sprawdzania aplikacji i wymusza na klientach uzyskanie nowego atestu od wybranych dostawców atestów. Może to negatywnie wpłynąć na wydajność i potencjalnie wyczerpać możliwości dostawców atestów. i zwiększanie limitów. Używaj tej funkcji tylko do ochrony dużych ilości danych oraz zabezpieczeń krytycznych lub kosztownych operacji.

Nie ma ona wpływu na opcję enforceAppCheck. Jeśli zasada ma wartość Prawda, funkcja wywoływana automatycznie zwraca kod stanu 401 „Brak autoryzacji”, jeśli żądanie zawiera nieprawidłowy token Sprawdzania aplikacji. Jeśli żądanie zawiera prawidłowe, ale wykorzystane tokeny Sprawdzania aplikacji, żądania nie będą automatycznie odrzucane. Zamiast tego właściwość request.app.alreadyConsumed zostanie ustawiona na „true” i przekaże wykonanie kodu do kodu modułu obsługi na potrzeby podejmowania dalszych decyzji, takich jak wymóg przeprowadzenia dodatkowych kontroli bezpieczeństwa lub odrzucenia żądania.

Podpis:

consumeAppCheckToken?: boolean;

RuntimeOptions.enforceAppCheck

Określa, czy egzekwowana jest funkcja Firebase AppCheck.

Jeśli ma wartość Prawda, żądania z nieprawidłowymi tokenami automatycznie odpowiadają o błędzie 401 (Brak autoryzacji). Jeśli zasada ma wartość Fałsz, żądania z nieprawidłowymi tokenami powodują ustawienie atrybutu context.app na wartość niebronioną.

Podpis:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy (zasada RuntimeOptions.failurePolicy)

Zasada niepowodzenia funkcji, przy czym wartość logiczna true oznacza podanie pustego obiektu ponowienia próby.

Podpis:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

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

Podpis:

ingressSettings?: (typeof INGRESS_SETTINGS_OPTIONS)[number] | ResetValue;

RuntimeOptions.invoker.

Wywołujący do ustawiania kontroli dostępu do funkcji https.

Podpis:

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

RuntimeOptions.labels (Opcje środowiska wykonawczego.labels)

Etykiety użytkownika do ustawienia dla funkcji.

Podpis:

labels?: Record<string, string>;

RuntimeOptions.maxInstances

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

Podpis:

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

RuntimeOptions.memory.

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

Podpis:

memory?: (typeof VALID_MEMORY_OPTIONS)[number] | Expression<number> | ResetValue;

RuntimeOptions.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;

RuntimeOptions.preserveExternalChanges

Określa, czy konfiguracja funkcji zmodyfikowana poza źródłem funkcji jest zachowywana. Wartość domyślna to fałsz.

Zdecydowanie zalecamy, aby podczas ustawiania konfiguracji dostępnej na platformie bazowej, która nie jest jeszcze dostępna w pakiecie SDK funkcji Firebase, ustaw wartość preserveExternalChanges na true. W przeciwnym razie, gdy pakiet SDK funkcji Firebase opublikuje nową wersję pakietu SDK z obsługą brakującej konfiguracji, ustawienia Twojej funkcji skonfigurowane ręcznie mogą zostać nieumyślnie wyczyszczone.

Podpis:

preserveExternalChanges?: boolean;

RuntimeOptions.secrets

Podpis:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount

Określone konto usługi, jako którego funkcja ma być uruchamiana.

Podpis:

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

RuntimeOptions.timeoutSeconds

Czas oczekiwania funkcji w sekundach. Możliwe wartości to od 0 do 540.

Podpis:

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

RuntimeOptions.vpcConnector

Połącz funkcję w Cloud Functions z określonym oprogramowaniem sprzęgającym VPC.

Podpis:

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

RuntimeOptions.vpcConnectorEgressSettings.

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

Podpis:

vpcConnectorEgressSettings?: (typeof VPC_EGRESS_SETTINGS_OPTIONS)[number] | ResetValue;