GlobalOptions interface

GlobalOptions adalah opsi yang dapat ditetapkan di seluruh project. Opsi ini umum untuk fungsi penanganan peristiwa dan HTTPS.

Tanda Tangan:

export interface GlobalOptions 

Properti

Properti	Jenis	Deskripsi
serentak	angka | Ekspresi<angka> | NilaiReset	Jumlah permintaan yang dapat ditayangkan oleh fungsi sekaligus.
cpu	angka | "gcf_gen1"	Jumlah pecahan CPU yang akan dialokasikan ke suatu fungsi.
menerapkan AppCheck	boolean	Menentukan apakah Firebase App Check diterapkan. Nilai defaultnya adalah false (salah).
Setelan masuk	Setelan Masuk | NilaiReset	Setelan masuk yang mengontrol tempat asal fungsi ini dapat dipanggil.
pemanggil	"publik" | "pribadi" | rangkaian | {i>string<i}[]	Invoker untuk menetapkan kontrol akses pada fungsi HTTPS.
label	Rekam<string, string>	Label pengguna yang akan ditetapkan pada fungsi.
maxInstances	angka | Ekspresi<angka> | NilaiReset	Jumlah instance maksimum yang dapat dijalankan secara paralel.
memori	MemoryOption | Ekspresi<angka> | NilaiReset	Jumlah memori yang akan dialokasikan ke suatu fungsi.
minInstances	angka | Ekspresi<angka> | NilaiReset	Jumlah minimum instance sebenarnya yang akan dijalankan pada waktu tertentu.
hapus	boolean | Ekspresi<boolean>	Jika true (benar), jangan men-deploy atau mengemulasi fungsi ini.
preserveExternalChanges	boolean	Mengontrol apakah konfigurasi fungsi yang dimodifikasi di luar sumber fungsi dipertahankan. Nilai defaultnya adalah false (salah).
region	DidukungRegion | rangkaian | Ekspresi<string> | NilaiReset	Region tempat fungsi harus di-deploy.
rahasia	(string | SecretParam)[]
akunlayanan	rangkaian | Ekspresi<string> | NilaiReset	Akun layanan tertentu yang akan digunakan untuk menjalankan fungsi.
timeoutSeconds	angka | Ekspresi<angka> | NilaiReset	Waktu tunggu untuk fungsi dalam detik, nilai yang mungkin adalah 0 hingga 540. Fungsi HTTPS dapat menentukan waktu tunggu yang lebih tinggi.
vpcConnector	rangkaian | Ekspresi<string> | NilaiReset	Menghubungkan fungsi ke konektor VPC yang ditentukan.
vpcConnectorEgressSettings	VpcEgressSetting | NilaiReset	Setelan traffic keluar untuk konektor VPC.

GlobalOptions.concurrency

Jumlah permintaan yang dapat ditayangkan oleh fungsi sekaligus.

Hanya dapat diterapkan ke fungsi yang berjalan di Cloud Functions (generasi ke-2)). Nilai null memulihkan konkurensi default (80 jika CPU >= 1, jika tidak 1). Konkurensi tidak dapat ditetapkan ke nilai apa pun selain 1 jika cpu kurang dari 1. Nilai maksimum untuk konkurensi adalah 1.000.

Tanda Tangan:

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

GlobalOptions.cpu

Jumlah pecahan CPU yang akan dialokasikan ke suatu fungsi.

Setelan defaultnya adalah 1 untuk fungsi dengan RAM <= 2 GB dan akan ditingkatkan untuk ukuran memori yang lebih besar. Jumlah ini berbeda dengan jumlah default saat menggunakan utilitas gcloud dan berbeda dengan jumlah tetap yang ditetapkan di Cloud Functions (generasi ke-1). Untuk mengembalikan ke jumlah CPU yang digunakan di gcloud atau di Cloud Functions (generasi ke-1), tetapkan nilai ini ke nilai "gcf_gen1"

Tanda Tangan:

cpu?: number | "gcf_gen1";

GlobalOptions.enforceAppCheck

Menentukan apakah Firebase App Check diterapkan. Nilai defaultnya adalah false (salah).

Jika benar, permintaan dengan token yang tidak valid akan otomatis merespons dengan error 401 (Tidak Sah). Jika salah (false), permintaan dengan token yang tidak valid akan menetapkan event.app ke undefined.

Tanda Tangan:

enforceAppCheck?: boolean;

GlobalOptions.ingressSettings

Setelan masuk yang mengontrol tempat asal fungsi ini dapat dipanggil.

Tanda Tangan:

ingressSettings?: IngressSetting | ResetValue;

GlobalOptions.invoker

Invoker untuk menetapkan kontrol akses pada fungsi HTTPS.

Tanda Tangan:

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

GlobalOptions.labels

Label pengguna yang akan ditetapkan pada fungsi.

Tanda Tangan:

labels?: Record<string, string>;

GlobalOptions.maxInstances

Jumlah instance maksimum yang dapat berjalan secara paralel.

Tanda Tangan:

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

GlobalOptions.memory

Jumlah memori yang akan dialokasikan ke suatu fungsi.

Tanda Tangan:

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

GlobalOptions.minInstances

Jumlah minimum instance sebenarnya yang akan dijalankan pada waktu tertentu.

Instance dikenai biaya untuk alokasi memori dan 10% alokasi CPU saat tidak ada aktivitas.

Tanda Tangan:

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

GlobalOptions.omit

Jika true (benar), jangan men-deploy atau mengemulasi fungsi ini.

Tanda Tangan:

omit?: boolean | Expression<boolean>;

GlobalOptions.preserveExternalChanges

Mengontrol apakah konfigurasi fungsi yang dimodifikasi di luar sumber fungsi dipertahankan. Nilai defaultnya adalah false (salah).

Saat menyetel konfigurasi yang tersedia di platform dasar yang belum tersedia di Firebase SDK untuk Cloud Functions, sebaiknya setel preserveExternalChanges ke true. Jika tidak, saat Google merilis versi baru SDK dengan dukungan untuk konfigurasi yang tidak ada, setelan fungsi yang dikonfigurasi secara manual mungkin akan terhapus secara tidak sengaja.

Tanda Tangan:

preserveExternalChanges?: boolean;

GlobalOptions.region

Region tempat fungsi harus di-deploy.

Tanda Tangan:

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

GlobalOptions.secrets

Tanda Tangan:

secrets?: (string | SecretParam)[];

GlobalOptions.serviceAccount

Akun layanan tertentu yang akan digunakan untuk menjalankan fungsi.

Tanda Tangan:

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

GlobalOptions.timeoutSeconds

Waktu tunggu untuk fungsi dalam detik, nilai yang mungkin adalah 0 hingga 540. Fungsi HTTPS dapat menentukan waktu tunggu yang lebih tinggi.

Waktu tunggu minimum untuk fungsi generasi ke-2 adalah 1 dtk. Waktu tunggu maksimum untuk suatu fungsi bergantung pada jenis fungsi: Fungsi penanganan peristiwa memiliki waktu tunggu maksimum 540 dtk (9 menit). Fungsi callable dan HTTPS memiliki waktu tunggu maksimum 36.000 detik (1 jam). Fungsi task queue memiliki waktu tunggu maksimum 1.800 detik (30 menit).

Tanda Tangan:

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

GlobalOptions.vpcConnector

Menghubungkan fungsi ke konektor VPC yang ditentukan.

Tanda Tangan:

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

GlobalOptions.vpcConnectorEgressSettings

Setelan traffic keluar untuk konektor VPC.

Tanda Tangan:

vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;