GlobalOptions
adalah opsi yang dapat diatur di seluruh proyek. Opsi ini umum untuk HTTPS dan fungsi penanganan kejadian.
Tanda tangan:
export interface GlobalOptions
Properti
Properti | Jenis | Keterangan |
---|---|---|
konkurensi | nomor | Ekspresi <angka> | Atur Ulang Nilai | Jumlah permintaan yang dapat dilayani suatu fungsi sekaligus. |
CPU | nomor | "gcf_gen1" | Jumlah pecahan CPU yang akan dialokasikan ke suatu fungsi. |
menegakkanAppCheck | boolean | Menentukan apakah Firebase App Check diterapkan. Defaultnya salah. |
pengaturan masuk | Pengaturan Ingress | Atur Ulang Nilai | Pengaturan Ingress yang mengontrol dari mana fungsi ini dapat dipanggil. |
pemanggil | "publik" | "pribadi" | tali | rangkaian[] | Invoker untuk mengatur kontrol akses pada fungsi HTTPS. |
label | Rekam<string, string> | Label pengguna untuk mengatur fungsi. |
maxInstances | nomor | Ekspresi <angka> | Atur Ulang Nilai | Jumlah maksimum instance yang dapat dijalankan secara paralel. |
Penyimpanan | Opsi Memori | Ekspresi <angka> | Atur Ulang Nilai | Jumlah memori yang akan dialokasikan ke suatu fungsi. |
menitInstances | nomor | Ekspresi <angka> | Atur Ulang Nilai | Jumlah minimum instance aktual yang akan dijalankan pada waktu tertentu. |
menghilangkan | boolean | Ekspresi <boolean> | Jika benar, jangan terapkan atau tiru fungsi ini. |
pertahankanPerubahan Eksternal | boolean | Mengontrol apakah konfigurasi fungsi yang diubah di luar sumber fungsi dipertahankan. Defaultnya salah. |
wilayah | Wilayah yang Didukung | tali | Ekspresi <string> | Atur Ulang Nilai | Wilayah tempat fungsi harus disebarkan. |
rahasia | (string | RahasiaParam)[] | |
akun layanan | tali | Ekspresi <string> | Atur Ulang Nilai | Akun layanan khusus untuk menjalankan fungsi tersebut. |
batas waktuDetik | nomor | Ekspresi <angka> | Atur Ulang Nilai | Batas waktu untuk fungsi dalam hitungan detik, nilai yang mungkin adalah 0 hingga 540. Fungsi HTTPS dapat menentukan batas waktu yang lebih tinggi. |
vpcConnector | tali | Ekspresi <string> | Atur Ulang Nilai | Hubungkan fungsi ke konektor VPC tertentu. |
vpcConnectorEgressSettings | Pengaturan VpcEgress | Atur Ulang Nilai | Pengaturan jalan keluar untuk konektor VPC. |
GlobalOptions.konkurensi
Jumlah permintaan yang dapat dilayani suatu fungsi sekaligus.
Hanya dapat diterapkan pada fungsi yang berjalan di Cloud Functions (generasi ke-2)). Nilai null mengembalikan konkurensi default (80 ketika CPU > = 1, 1 sebaliknya). Konkurensi tidak dapat disetel 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.
Defaultnya adalah 1 untuk fungsi dengan < = RAM 2GB dan bertambah 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 jumlah CPU yang digunakan di gcloud atau Cloud Functions (generasi ke-1), setel nilai ini ke nilai "gcf_gen1"
Tanda tangan:
cpu?: number | "gcf_gen1";
GlobalOptions.enforceAppCheck
Menentukan apakah Firebase App Check diterapkan. Defaultnya salah.
Jika benar, permintaan dengan token yang tidak valid akan dibalas secara otomatis dengan kesalahan 401 (Tidak Sah). Jika salah, permintaan dengan token yang tidak valid akan menyetel event.app
ke undefined
.
Tanda tangan:
enforceAppCheck?: boolean;
GlobalOptions.ingressSettings
Pengaturan Ingress yang mengontrol dari mana fungsi ini dapat dipanggil.
Tanda tangan:
ingressSettings?: IngressSetting | ResetValue;
GlobalOptions.invoker
Invoker untuk mengatur kontrol akses pada fungsi HTTPS.
Tanda tangan:
invoker?: "public" | "private" | string | string[];
GlobalOptions.label
Label pengguna untuk mengatur fungsi.
Tanda tangan:
labels?: Record<string, string>;
GlobalOptions.maxInstances
Jumlah maksimum instance yang dapat dijalankan secara paralel.
Tanda tangan:
maxInstances?: number | Expression<number> | ResetValue;
GlobalOptions.memori
Jumlah memori yang akan dialokasikan ke suatu fungsi.
Tanda tangan:
memory?: MemoryOption | Expression<number> | ResetValue;
GlobalOptions.minInstances
Jumlah minimum instance aktual yang akan dijalankan pada waktu tertentu.
Mesin virtual ditagih untuk alokasi memori dan 10% alokasi CPU saat menganggur.
Tanda tangan:
minInstances?: number | Expression<number> | ResetValue;
GlobalOptions.hilangkan
Jika benar, jangan terapkan atau tiru fungsi ini.
Tanda tangan:
omit?: boolean | Expression<boolean>;
GlobalOptions.preserveExternalChanges
Mengontrol apakah konfigurasi fungsi yang diubah di luar sumber fungsi dipertahankan. Defaultnya salah.
Saat menyetel konfigurasi 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 hilang, setelan fungsi Anda yang dikonfigurasi secara manual mungkin terhapus secara tidak sengaja.
Tanda tangan:
preserveExternalChanges?: boolean;
GlobalOptions.wilayah
Wilayah tempat fungsi harus disebarkan.
Tanda tangan:
region?: SupportedRegion | string | Expression<string> | ResetValue;
GlobalOptions.rahasia
Tanda tangan:
secrets?: (string | SecretParam)[];
GlobalOptions.serviceAccount
Akun layanan khusus untuk menjalankan fungsi tersebut.
Tanda tangan:
serviceAccount?: string | Expression<string> | ResetValue;
GlobalOptions.timeoutSeconds
Batas waktu untuk fungsi dalam hitungan detik, nilai yang mungkin adalah 0 hingga 540. Fungsi HTTPS dapat menentukan batas waktu yang lebih tinggi.
Batas waktu minimum untuk fungsi generasi ke-2 adalah 1 detik. Batas waktu maksimum untuk suatu fungsi bergantung pada jenis fungsinya: Fungsi penanganan peristiwa memiliki batas waktu maksimum 540 detik (9 menit). HTTPS dan fungsi yang dapat dipanggil memiliki batas waktu maksimum 36,00 detik (1 jam). Fungsi antrian tugas memiliki batas waktu maksimum 1.800 detik (30 menit).
Tanda tangan:
timeoutSeconds?: number | Expression<number> | ResetValue;
GlobalOptions.vpcConnector
Hubungkan fungsi ke konektor VPC tertentu.
Tanda tangan:
vpcConnector?: string | Expression<string> | ResetValue;
Pengaturan GlobalOptions.vpcConnectorEgress
Pengaturan jalan keluar untuk konektor VPC.
Tanda tangan:
vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;