GlobalOptions interface

GlobalOptions adalah opsi yang dapat diatur di seluruh proyek. Opsi ini umum untuk HTTPS dan fungsi penanganan Acara.

Tanda tangan:

export interface GlobalOptions 

Properti

GlobalOptions.concurrency

Jumlah permintaan yang dapat dilayani suatu fungsi sekaligus.

Hanya dapat diterapkan pada fungsi yang berjalan di Cloud Functions v2. Nilai null mengembalikan konkurensi default (80 saat CPU > = 1, 1 jika tidak). Konkurensi tidak dapat diatur 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 untuk dialokasikan ke suatu fungsi.

Default ke 1 untuk fungsi dengan < = 2GB RAM dan meningkat untuk ukuran memori yang lebih besar. Ini berbeda dengan nilai default saat menggunakan utilitas gcloud dan berbeda dengan jumlah tetap yang ditetapkan di Google Cloud Functions generasi 1. Untuk mengembalikan ke jumlah CPU yang digunakan di gcloud atau di Cloud Functions generasi 1, tetapkan ini ke nilai "gcf_gen1"

Tanda tangan:

cpu?: number | "gcf_gen1";

GlobalOptions.enforceAppCheck

Menentukan apakah Firebase AppCheck diterapkan. Default ke salah.

Jika benar, permintaan dengan token yang tidak valid ditanggapi secara otomatis dengan kesalahan 401 (Tidak Sah). Jika salah, permintaan dengan token yang tidak valid menyetel event.app ke undefiend.

Tanda tangan:

enforceAppCheck?: boolean;

Pengaturan GlobalOptions.ingress

Pengaturan masuknya 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.labels

Label pengguna untuk disetel pada fungsi.

Tanda tangan:

labels?: Record<string, string>;

GlobalOptions.maxInstances

Jumlah maksimum instance yang akan berjalan 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 instans aktual yang akan dijalankan pada waktu tertentu.

Instance akan ditagih untuk alokasi memori dan 10% alokasi CPU saat tidak ada aktivitas.

Tanda tangan:

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

GlobalOptions.omit

Jika true, jangan terapkan atau tiru fungsi ini.

Tanda tangan:

omit?: boolean | Expression<boolean>;

GlobalOptions.preserveExternalChanges

Mengontrol apakah konfigurasi fungsi yang dimodifikasi di luar sumber fungsi dipertahankan. Default ke salah.

Saat menyetel konfigurasi yang tersedia di platform dasar yang belum tersedia di Firebase Functions SDK, kami sangat menyarankan untuk menyetel preserveExternalChanges ke true . Jika tidak, saat Firebase Functions SDK merilis versi baru SDK dengan dukungan untuk konfigurasi yang hilang, setelan fungsi yang dikonfigurasi secara manual mungkin terhapus secara tidak sengaja.

Tanda tangan:

preserveExternalChanges?: boolean;

GlobalOptions.region

Wilayah tempat fungsi harus diterapkan.

Tanda tangan:

region?: SupportedRegion | string;

GlobalOptions.rahasia

Tanda tangan:

secrets?: (string | SecretParam)[];

GlobalOptions.serviceAccount

Akun layanan khusus untuk menjalankan fungsi sebagai.

Tanda tangan:

serviceAccount?: string | ResetValue;

GlobalOptions.timeoutSeconds

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

Batas waktu minimum untuk fungsi gen 2 adalah 1 detik. Batas waktu maksimum untuk suatu fungsi bergantung pada jenis fungsi: Fungsi penanganan acara 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 cloud function ke konektor VPC yang ditentukan.

Tanda tangan:

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

GlobalOptions.vpcConnectorEgressSettings

Setelan jalan keluar untuk konektor VPC.

Tanda tangan:

vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;