GlobalOptions interface

GlobalOptions , projenin tamamında ayarlanabilecek 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 fonksiyonun aynı anda sunabileceği istek sayısı.
İşlemci sayı | "gcf_gen1" Bir işleve tahsis edilecek kesirli CPU sayısı.
Uygulama Kontrolü'nü uygula boolean Firebase Uygulama Kontrolü'nün uygulanıp uygulanmayacağını belirler. Varsayılan olarak false olur.
girişAyarları Giriş Ayarı | Değeri Sıfırla Bu işlevin nereden çağrılabileceğini kontrol eden giriş ayarları.
çağıran "genel" | "özel" | dize | sicim[] HTTPS işlevlerine erişim kontrolünü ayarlamak için çağrıcı.
etiketler Kayıt<string, string> İşlevde ayarlanacak kullanıcı etiketleri.
maxInstances sayı | İfade <sayı> | Değeri Sıfırla Paralel olarak çalışabilecek maksimum örnek sayısı.
hafıza Bellek 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 minimum 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 boolean İşlev kaynağı dışında değiştirilen işlev yapılandırmasının korunup korunmadığını kontrol eder. Varsayılan olarak false olur.
bölge Desteklenen Bölge | dize | İfade <string> | Değeri Sıfırla İşlevlerin dağıtılması gereken bölge.
sırlar (string | SecretParam)[]
hizmetHesabı dize | İfade <string> | Değeri Sıfırla İşlevin ç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 arasındadır. HTTPS işlevleri daha yüksek bir zaman aşımı belirtebilir.
vpcConnector dize | İfade <string> | Değeri Sıfırla Bir işlevi belirtilen bir VPC konektörüne bağlayın.
vpcConnectorEgressSettings VpcEgressAyarları | Değeri Sıfırla VPC konektörü için çıkış ayarları.

GlobalOptions.concurrency

Bir fonksiyonun aynı anda sunabileceği istek sayısı.

Yalnızca Cloud Functions (2. nesil) üzerinde çalışan işlevlere uygulanabilir. null değeri varsayılan eşzamanlılığı geri yükler (CPU > = 1, aksi takdirde 1). cpu 1'den küçükse eşzamanlılık 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.cpu

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

< içeren işlevler için varsayılan 1'dir = 2GB RAM ve daha büyük bellek boyutları için artar. Bu, gcloud yardımcı programını kullanırken varsayılanlardan farklıdır ve Cloud Functions'ta (1. nesil) atanan sabit tutardan farklıdır. gcloud veya Cloud Functions'ta (1. nesil) 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 Uygulama Kontrolü'nün uygulanıp uygulanmayacağını belirler. Varsayılan olarak false olur.

Doğru olduğunda, geçersiz belirteçlere sahip istekler 401 (Yetkisiz) hatasıyla otomatik olarak yanıtlanır. Yanlış olduğunda, geçersiz belirteçlere sahip istekler event.app undefined 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şlevlerine erişim kontrolünü ayarlamak için çağrıcı.

İmza:

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

GlobalOptions.labels

İşlevde ayarlanacak kullanıcı etiketleri.

İmza:

labels?: Record<string, string>;

GlobalOptions.maxInstances

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

İmza:

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

GlobalOptions.memory

Bir işleve ayrılacak bellek miktarı.

İmza:

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

GlobalOptions.minInstances

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

Bulut sunucuları boştayken bellek tahsisi ve CPU tahsisinin %10'u için faturalandırılı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ğı dışında değiştirilen işlev yapılandırmasının korunup korunmadığını kontrol eder. Varsayılan olarak false olur.

Cloud Functions için henüz Firebase SDK'sında bulunmayan temel bir platformda mevcut olan yapılandırmayı ayarlarken, preserveExternalChanges true olarak ayarlamanızı öneririz. . Aksi takdirde Google, 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 | Expression<string> | ResetValue;

GlobalOptions.secrets

İmza:

secrets?: (string | SecretParam)[];

GlobalOptions.serviceHesabı

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

İmza:

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

GlobalOptions.timeoutSeconds

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

2. nesil bir işlev 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

Bir işlevi belirtilen bir VPC konektörüne bağlayın.

İmza:

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

GlobalOptions.vpcConnectorEgressSettings

VPC konektörü için çıkış ayarları.

İmza:

vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;