GlobalOptions interface

GlobalOptions, tüm proje boyunca ayarlanabilen seçeneklerdir. Bu seçenekler, HTTPS ve Olay işleme işlevlerinde ortaktır.

İmza:

export interface GlobalOptions 

Özellikler

Mülk Tip Tanım
eşzamanlılık sayı | İfade<sayı> | Değeri Sıfırla Bir işlevin aynı anda sunabileceği istek sayısı.
İşlemci sayı | "gcf_gen1" Bir işleve tahsis edilecek kesirli CPU sayısı.
zorlaUygulama Kontrolü mantıksal Firebase AppCheck'in zorunlu olup olmadığını belirler. Varsayılan olarak false.
giriş Ayarları Giriş Ayarı | Değeri Sıfırla Bu işlevin nereden çağrılabileceğini kontrol eden giriş ayarları.
çağıran "kamu" | "özel" | dizi | sicim[] https işlevlerinde erişim denetimi ayarlamak için çağırıcı.
etiketler Kayıt<dize, dize> İşlev üzerinde ayarlanacak kullanıcı etiketleri.
maxÖrnekler sayı | İfade<sayı> | Değeri Sıfırla Paralel olarak çalışacak maksimum örnek sayısı.
hafıza Hafıza Seçeneği | İfade<sayı> | Değeri Sıfırla Bir işleve ayrılacak bellek miktarı.
minörnekler sayı | İfade<sayı> | Değeri Sıfırla Belirli bir zamanda çalıştırılacak en az gerçek örnek sayısı.
çıkarmak Boole | İfade<boolean> Doğruysa, bu işlevi dağıtmayın veya taklit etmeyin.
Dış Değişiklikleri koru mantıksal İşlev kaynağının dışında değiştirilen işlev konfigürasyonunun korunup korunmadığını kontrol eder. Varsayılan olarak false.
bölge Desteklenen Bölge | sicim İşlevlerin dağıtılması gereken bölge.
sırlar (dize | SecretParam)[]
hizmetHesabı dizi | Değeri Sıfırla İşlevin farklı çalıştırılacağı özel hizmet hesabı.
zaman aşımıSaniye sayı | İfade<sayı> | Değeri Sıfırla İşlev için saniye cinsinden zaman aşımı, olası değerler 0 ila 540'tır. HTTPS işlevleri daha yüksek bir zaman aşımı belirtebilir.
vpcConnector dizi | İfade<dize> | Değeri Sıfırla Bulut işlevini belirtilen VPC konektörüne bağlayın.
vpcConnectorEgressSettings VpcEgressSetting | Değeri Sıfırla VPC bağlayıcısı için çıkış ayarları.

GlobalOptions.eşzamanlılık

Bir işlevin aynı anda sunabileceği istek sayısı.

Yalnızca Cloud Functions v2 üzerinde çalışan işlevlere uygulanabilir. null değeri, varsayılan eşzamanlılığı geri yükler (CPU > = 1, aksi halde 1). cpu 1'den başka bir değere ayarlanamaz. Eşzamanlılık için maksimum değer 1.000'dir.

İmza:

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

GlobalOptions.işlemci

Bir işleve tahsis edilecek kesirli CPU sayısı.

< olan işlevler için varsayılan değer 1'dir = 2GB RAM ve daha büyük bellek boyutları için artar. Bu, gcloud yardımcı programı kullanılırken varsayılanlardan farklıdır ve Google Cloud Functions 1. nesilde atanan sabit miktardan farklıdır. gcloud'da veya Cloud Functions 1. nesilde kullanılan CPU miktarlarına geri dönmek için bunu "gcf_gen1" değerine ayarlayın

İmza:

cpu?: number | "gcf_gen1";

GlobalOptions.enforceAppCheck

Firebase AppCheck'in zorunlu olup olmadığını belirler. Varsayılan olarak false.

Doğru olduğunda, geçersiz belirteçlere sahip istekler otomatik olarak 401 (Yetkisiz) hatasıyla yanıt verir. Yanlış olduğunda, geçersiz belirteçlere sahip istekler event.app'i savunmasız olarak ayarlar.

İmza:

enforceAppCheck?: boolean;

GlobalOptions.ingressSettings

Bu işlevin nereden çağrılabileceğini kontrol eden giriş ayarları.

İmza:

ingressSettings?: IngressSetting | ResetValue;

GlobalOptions.invoker

https işlevlerinde erişim denetimi ayarlamak için çağırıcı.

İmza:

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

GlobalOptions.etiketler

İşlev üzerinde ayarlanacak kullanıcı etiketleri.

İmza:

labels?: Record<string, string>;

GlobalOptions.maxInstances

Paralel olarak çalışacak maksimum örnek sayısı.

İmza:

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

GlobalOptions.bellek

Bir işleve ayrılacak bellek miktarı.

İmza:

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

GlobalOptions.minÖrnekler

Belirli bir zamanda çalıştırılacak en az gerçek örnek sayısı.

Örnekler, boştayken bellek tahsisi ve CPU tahsisinin %10'u için faturalandırılacaktır.

İmza:

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

GlobalOptions.omit

Doğruysa, bu işlevi dağıtmayın veya taklit etmeyin.

İmza:

omit?: boolean | Expression<boolean>;

GlobalOptions.preserveExternalChanges

İşlev kaynağının dışında değiştirilen işlev konfigürasyonunun korunup korunmadığını kontrol eder. Varsayılan olarak false.

Firebase Functions SDK'da henüz mevcut olmayan, temel platformda mevcut olan konfigürasyonu ayarlarken, preserveExternalChanges true olarak ayarlanmasını önemle tavsiye ederiz. . Aksi takdirde, Firebase Functions SDK, eksik yapılandırmayı destekleyen yeni bir SDK sürümü yayınladığında, işlevinizin manuel olarak yapılandırılan ayarı yanlışlıkla silinebilir.

İmza:

preserveExternalChanges?: boolean;

GlobalOptions.bölge

İşlevlerin dağıtılması gereken bölge.

İmza:

region?: SupportedRegion | string;

GlobalOptions.secrets

İmza:

secrets?: (string | SecretParam)[];

GlobalOptions.hizmetHesabı

İşlevin farklı çalıştırılacağı özel hizmet hesabı.

İmza:

serviceAccount?: string | ResetValue;

GlobalOptions.timeoutSeconds

İşlev için saniye cinsinden zaman aşımı, olası değerler 0 ila 540'tır. HTTPS işlevleri daha yüksek bir zaman aşımı belirtebilir.

Gen 2 işlevi için minimum zaman aşımı süresi 1 saniyedir. Bir işlev için maksimum zaman aşımı, işlevin türüne bağlıdır: Olay işleme işlevlerinin maksimum zaman aşımı süresi 540 saniyedir (9 dakika). HTTPS ve çağrılabilir işlevlerin maksimum zaman aşımı süresi 36,00 saniyedir (1 saat). Görev kuyruğu işlevlerinin maksimum zaman aşımı süresi 1.800 saniyedir (30 dakika)

İmza:

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

GlobalOptions.vpcConnector

Bulut işlevini belirtilen VPC konektörüne bağlayın.

İmza:

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

GlobalOptions.vpcConnectorEgressSettings

VPC bağlayıcısı için çıkış ayarları.

İmza:

vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;