GlobalOptions interface

GlobalOptions, projenin tamamında ayarlanabilen seçeneklerdir. Bu seçenekler, HTTPS ve olay işleme işlevlerinde yaygındır.

İmza:

export interface GlobalOptions 

Özellikler

Özellik Tür Açıklama
eşzamanlılık sayı | İfade<sayı> | Değeri Sıfırla Bir işlevin aynı anda sunabileceği istek sayısı.
cpu sayı | "gcf_gen1" Bir işleve ayrılacak kesirli CPU sayısı.
enforceAppCheck boolean Firebase Uygulama Kontrolü'nün uygulanıp uygulanmayacağını belirler. Varsayılan olarak yanlış değerine ayarlanır.
ingressSettings IngressSetting | Değeri Sıfırla Bu işlevin nereden çağrılabileceğini kontrol eden giriş ayarları.
çağrıcı "herkese açık" | "gizli" | dize | dize[] HTTPS işlevlerinde erişim denetimini ayarlamak için çağrıcı.
etiketler Kayıt<dize, dize> İşlevde ayarlanacak kullanıcı etiketleri.
maxInstances sayı | İfade<sayı> | Değeri Sıfırla Paralel olarak çalışabilecek maksimum örnek sayısı.
bellek MemoryOption | İfade<number> | Değeri Sıfırla Bir işleve ayrılacak bellek miktarı.
minstances sayı | İfade<sayı> | Değeri Sıfırla Belirli bir zamanda çalışacak minimum gerçek örnek sayısı.
çıkar boole | İfade<boole> True (doğru) ise bu işlevi dağıtmayın veya emüle etmeyin.
koruma haricideğişiklikleri boolean İşlev kaynağı dışında değiştirilen işlev yapılandırmasının korunup korunmadığını kontrol eder. Varsayılan olarak yanlış değerine ayarlanır.
region [bölge] DesteklenenBölge | dize | İfade<string> | Değeri Sıfırla İşlevlerin dağıtılması gereken bölge.
sırlar (dize | SecretParam)[]
serviceAccount dize | İfade<string> | Değeri Sıfırla İşlevin çalıştırılacağı belirli hizmet hesabı.
timeoutSeconds sayı | İfade<sayı> | Değeri Sıfırla İşlev için saniye cinsinden zaman aşımı. Olası değerler 0 ile 540 arasındadır. HTTPS işlevleri daha yüksek bir zaman aşımı belirtebilir.
vpcConnector dize | İfade<string> | Değeri Sıfırla Belirli bir VPC bağlayıcısına işlev bağlayın.
vpcConnectorEgressSettings VpcEgressSetting | Değeri Sıfırla VPC bağlayıcısı için çıkış ayarları.

GlobalOptions.concurrency

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

Yalnızca Cloud Functions'da (2. nesil) çalışan işlevlere uygulanabilir. Null değeri, varsayılan eşzamanlılığı geri yükler (CPU >= 1 olduğunda 80, aksi durumda 1 olur). cpu 1'den küçükse eşzamanlılık 1 dışında bir değere ayarlanamaz. Maksimum eşzamanlılık değeri 1.000'dir.

İmza:

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

GlobalOptions.cpu

Bir işleve ayrılacak kesirli CPU sayısı.

<= 2 GB RAM'e sahip işlevler için varsayılan olarak 1 değerine ayarlanır ve daha büyük bellek boyutları için bu değer artar. Bu değer, gcloud yardımcı programı kullanılırken sunulan varsayılanlardan farklıdır ve Cloud Functions'da (1. nesil) atanan sabit tutardan farklıdır. gcloud veya Cloud Functions'da (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 yanlış değerine ayarlanır.

Doğru olduğunda, geçersiz jetonlara sahip istekler 401 (Yetkisiz) hatasıyla otomatik olarak yanıt verir. Yanlış olduğunda, geçersiz jeton içeren istekler event.app undefined olarak ayarlanır.

İ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 denetimini ayarlamak için çağrıcı.

İmza:

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

GlobalSeçenekler.etiketler

İş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;

GenelSeçenekler.bellek

Bir işleve ayrılacak bellek miktarı.

İmza:

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

GlobalOptions.minInstances

Belirli bir zamanda çalışacak minimum gerçek örnek sayısı.

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

İmza:

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

GlobalOptions.omit

True (doğru) ise bu işlevi dağıtmayın veya emüle 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 yanlış değerine ayarlanır.

Cloud Functions için Firebase SDK'sında henüz bulunmayan bir temel platformda bulunan yapılandırmayı ayarlarken preserveExternalChanges politikasını true olarak ayarlamanızı öneririz. Aksi takdirde, Google eksik yapılandırma desteğiyle SDK'nın yeni bir sürümünü yayınladığında işlevinizin manuel olarak yapılandırılmış ayarı yanlışlıkla silinebilir.

İmza:

preserveExternalChanges?: boolean;

GlobalSeçenekler.bölge

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

İmza:

region?: SupportedRegion | string | Expression<string> | ResetValue;

GlobalOptions.sırlar

İmza:

secrets?: (string | SecretParam)[];

GlobalSeçenekler.hizmetHesabı

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

İmza:

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

GlobalOptions.timeoutSeconds (Küresel Seçenekler.timeoutSeconds)

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

2. nesil işlev için minimum zaman aşımı 1 saniyedir. Bir işlev için maksimum zaman aşımı süresi, işlevin türüne bağlıdır: Etkinlik işleme işlevlerinin maksimum zaman aşımı 540 saniye (9 dakika)dur. HTTPS ve çağrılabilir işlevlerin maksimum zaman aşımı 3600 saniye (1 saat) vardır. Görev sırası işlevlerinin zaman aşımı süresi en fazla 1.800 saniye (30 dakika) olabilir.

İmza:

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

GlobalOptions.vpcConnector

Belirli bir VPC bağlayıcısına işlev bağlayın.

İmza:

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

GlobalOptions.vpcConnectorEgressSettings

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

İmza:

vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;