RuntimeOptions interface

Opsi konfigurasi untuk fungsi yang berlaku saat runtime.

Tanda tangan:

export interface RuntimeOptions 

Properti

Properti Jenis Keterangan
mengkonsumsiAppCheckToken boolean Menentukan apakah token Firebase App Check digunakan berdasarkan permintaan. Defaultnya salah.
menegakkanAppCheck boolean Menentukan apakah Firebase AppCheck diterapkan.
kebijakan kegagalan Kebijakan Kegagalan | boolean Kebijakan kegagalan fungsi, dengan boolean true setara dengan menyediakan objek percobaan ulang yang kosong.
pengaturan masuk (ketik INGRESS_SETTINGS_OPTIONS )[angka] | 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 maksimal instance aktual yang diizinkan untuk dijalankan secara paralel.
Penyimpanan (ketik VALID_MEMORY_OPTIONS )[angka] | Ekspresi <angka> | Atur Ulang Nilai Jumlah memori yang akan dialokasikan ke fungsi tersebut.
menitInstances nomor | Ekspresi <angka> | Atur Ulang Nilai Jumlah minimum instance aktual yang akan dijalankan pada waktu tertentu.
pertahankanPerubahan Eksternal boolean Mengontrol apakah konfigurasi fungsi yang diubah di luar sumber fungsi dipertahankan. Defaultnya salah.
rahasia (string | RahasiaParam)[]
akun layanan "bawaan" | 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.
vpcConnector tali | Ekspresi <string> | Atur Ulang Nilai Hubungkan fungsi cloud ke konektor VPC yang ditentukan.
vpcConnectorEgressSettings (jenis VPC_EGRESS_SETTINGS_OPTIONS )[angka] | Atur Ulang Nilai Pengaturan jalan keluar untuk konektor VPC.

RuntimeOptions.consumeAppCheckToken

Menentukan apakah token Firebase App Check digunakan berdasarkan permintaan. Defaultnya salah.

Setel ini ke true untuk mengaktifkan fitur perlindungan pemutaran ulang App Check dengan menggunakan token App Check berdasarkan permintaan yang dapat dipanggil. Token yang ditemukan sudah dikonsumsi akan memiliki properti request.app.alreadyConsumed yang disetel ke true.

Token hanya dianggap dikonsumsi jika dikirim ke layanan App Check dengan menyetel opsi ini ke true. Kegunaan lain dari token tidak mengkonsumsinya.

Fitur perlindungan pemutaran ulang ini memerlukan panggilan jaringan tambahan ke backend App Check dan memaksa klien untuk mendapatkan pengesahan baru dari penyedia pengesahan yang dipilih. Oleh karena itu, hal ini dapat berdampak negatif terhadap kinerja dan berpotensi menghabiskan kuota penyedia pengesahan Anda lebih cepat. Gunakan fitur ini hanya untuk melindungi operasi bervolume rendah, kritis terhadap keamanan, atau mahal.

Opsi ini tidak memengaruhi opsi enforceAppCheck . Menyetel yang terakhir ke true akan menyebabkan fungsi yang dapat dipanggil secara otomatis merespons dengan kode status 401 Tidak Sah ketika permintaan menyertakan token App Check yang tidak valid. Jika permintaan menyertakan token App Check yang valid namun sudah digunakan, permintaan tidak akan ditolak secara otomatis. Sebaliknya, properti request.app.alreadyConsumed akan disetel ke true dan meneruskan eksekusi ke kode pengendali untuk membuat keputusan lebih lanjut, seperti memerlukan pemeriksaan keamanan tambahan atau menolak permintaan.

Tanda tangan:

consumeAppCheckToken?: boolean;

RuntimeOptions.enforceAppCheck

Menentukan apakah Firebase AppCheck diterapkan.

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 konteks.aplikasi menjadi tidak dapat ditentukan.

Tanda tangan:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

Kebijakan kegagalan fungsi, dengan boolean true setara dengan menyediakan objek percobaan ulang yang kosong.

Tanda tangan:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

Pengaturan Ingress yang mengontrol dari mana fungsi ini dapat dipanggil.

Tanda tangan:

ingressSettings?: (typeof INGRESS_SETTINGS_OPTIONS)[number] | ResetValue;

RuntimeOptions.invoker

Invoker untuk mengatur kontrol akses pada fungsi https.

Tanda tangan:

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

RuntimeOptions.labels

Label pengguna untuk mengatur fungsi.

Tanda tangan:

labels?: Record<string, string>;

RuntimeOptions.maxInstances

Jumlah maksimal instance aktual yang diizinkan untuk dijalankan secara paralel.

Tanda tangan:

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

RuntimeOptions.memori

Jumlah memori yang akan dialokasikan ke fungsi tersebut.

Tanda tangan:

memory?: (typeof VALID_MEMORY_OPTIONS)[number] | Expression<number> | ResetValue;

RuntimeOptions.minInstances

Jumlah minimum instance aktual yang akan dijalankan pada waktu tertentu.

Mesin virtual akan ditagih untuk alokasi memori dan 10% alokasi CPU saat menganggur.

Tanda tangan:

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

RuntimeOptions.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 Functions SDK, kami sangat menyarankan agar menyetel preserveExternalChanges ke true . Jika tidak, saat Firebase Functions SDK merilis versi baru SDK dengan dukungan untuk konfigurasi yang hilang, setelan yang dikonfigurasi secara manual pada fungsi Anda mungkin terhapus secara tidak sengaja.

Tanda tangan:

preserveExternalChanges?: boolean;

RuntimeOptions.rahasia

Tanda tangan:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount

Akun layanan khusus untuk menjalankan fungsi tersebut.

Tanda tangan:

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

RuntimeOptions.timeoutSeconds

Batas waktu untuk fungsi dalam hitungan detik, nilai yang mungkin adalah 0 hingga 540.

Tanda tangan:

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

RuntimeOptions.vpcConnector

Hubungkan fungsi cloud ke konektor VPC yang ditentukan.

Tanda tangan:

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

RuntimeOptions.vpcConnectorEgressSettings

Pengaturan jalan keluar untuk konektor VPC.

Tanda tangan:

vpcConnectorEgressSettings?: (typeof VPC_EGRESS_SETTINGS_OPTIONS)[number] | ResetValue;
,

Opsi konfigurasi untuk fungsi yang berlaku saat runtime.

Tanda tangan:

export interface RuntimeOptions 

Properti

Properti Jenis Keterangan
mengkonsumsiAppCheckToken boolean Menentukan apakah token Firebase App Check digunakan berdasarkan permintaan. Defaultnya salah.
menegakkanAppCheck boolean Menentukan apakah Firebase AppCheck diterapkan.
kebijakan kegagalan Kebijakan Kegagalan | boolean Kebijakan kegagalan fungsi, dengan boolean true setara dengan menyediakan objek percobaan ulang yang kosong.
pengaturan masuk (ketik INGRESS_SETTINGS_OPTIONS )[angka] | 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 maksimal instance aktual yang diizinkan untuk dijalankan secara paralel.
Penyimpanan (ketik VALID_MEMORY_OPTIONS )[angka] | Ekspresi <angka> | Atur Ulang Nilai Jumlah memori yang akan dialokasikan ke fungsi tersebut.
menitInstances nomor | Ekspresi <angka> | Atur Ulang Nilai Jumlah minimum instance aktual yang akan dijalankan pada waktu tertentu.
pertahankanPerubahan Eksternal boolean Mengontrol apakah konfigurasi fungsi yang diubah di luar sumber fungsi dipertahankan. Defaultnya salah.
rahasia (string | RahasiaParam)[]
akun layanan "bawaan" | 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.
vpcConnector tali | Ekspresi <string> | Atur Ulang Nilai Hubungkan fungsi cloud ke konektor VPC yang ditentukan.
vpcConnectorEgressSettings (jenis VPC_EGRESS_SETTINGS_OPTIONS )[angka] | Atur Ulang Nilai Pengaturan jalan keluar untuk konektor VPC.

RuntimeOptions.consumeAppCheckToken

Menentukan apakah token Firebase App Check digunakan berdasarkan permintaan. Defaultnya salah.

Setel ini ke true untuk mengaktifkan fitur perlindungan pemutaran ulang App Check dengan menggunakan token App Check berdasarkan permintaan yang dapat dipanggil. Token yang ditemukan sudah dikonsumsi akan memiliki properti request.app.alreadyConsumed yang disetel ke true.

Token hanya dianggap dikonsumsi jika dikirim ke layanan App Check dengan menyetel opsi ini ke true. Kegunaan lain dari token tidak mengkonsumsinya.

Fitur perlindungan pemutaran ulang ini memerlukan panggilan jaringan tambahan ke backend App Check dan memaksa klien untuk mendapatkan pengesahan baru dari penyedia pengesahan yang dipilih. Oleh karena itu, hal ini dapat berdampak negatif terhadap kinerja dan berpotensi menghabiskan kuota penyedia pengesahan Anda lebih cepat. Gunakan fitur ini hanya untuk melindungi operasi bervolume rendah, kritis terhadap keamanan, atau mahal.

Opsi ini tidak memengaruhi opsi enforceAppCheck . Menyetel yang terakhir ke true akan menyebabkan fungsi yang dapat dipanggil secara otomatis merespons dengan kode status 401 Tidak Sah ketika permintaan menyertakan token App Check yang tidak valid. Jika permintaan menyertakan token App Check yang valid namun sudah digunakan, permintaan tidak akan ditolak secara otomatis. Sebaliknya, properti request.app.alreadyConsumed akan disetel ke true dan meneruskan eksekusi ke kode pengendali untuk membuat keputusan lebih lanjut, seperti memerlukan pemeriksaan keamanan tambahan atau menolak permintaan.

Tanda tangan:

consumeAppCheckToken?: boolean;

RuntimeOptions.enforceAppCheck

Menentukan apakah Firebase AppCheck diterapkan.

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 konteks.aplikasi menjadi tidak dapat ditentukan.

Tanda tangan:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

Kebijakan kegagalan fungsi, dengan boolean true setara dengan menyediakan objek percobaan ulang yang kosong.

Tanda tangan:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

Pengaturan Ingress yang mengontrol dari mana fungsi ini dapat dipanggil.

Tanda tangan:

ingressSettings?: (typeof INGRESS_SETTINGS_OPTIONS)[number] | ResetValue;

RuntimeOptions.invoker

Invoker untuk mengatur kontrol akses pada fungsi https.

Tanda tangan:

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

RuntimeOptions.labels

Label pengguna untuk mengatur fungsi.

Tanda tangan:

labels?: Record<string, string>;

RuntimeOptions.maxInstances

Jumlah maksimal instance aktual yang diizinkan untuk dijalankan secara paralel.

Tanda tangan:

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

RuntimeOptions.memori

Jumlah memori yang akan dialokasikan ke fungsi tersebut.

Tanda tangan:

memory?: (typeof VALID_MEMORY_OPTIONS)[number] | Expression<number> | ResetValue;

RuntimeOptions.minInstances

Jumlah minimum instance aktual yang akan dijalankan pada waktu tertentu.

Instance akan ditagih untuk alokasi memori dan 10% alokasi CPU saat idle.

Tanda tangan:

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

RuntimeOptions.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 Functions SDK, kami sangat menyarankan agar menyetel preserveExternalChanges ke true . Jika tidak, saat Firebase Functions SDK merilis versi baru SDK dengan dukungan untuk konfigurasi yang hilang, setelan yang dikonfigurasi secara manual pada fungsi Anda mungkin terhapus secara tidak sengaja.

Tanda tangan:

preserveExternalChanges?: boolean;

RuntimeOptions.rahasia

Tanda tangan:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount

Akun layanan khusus untuk menjalankan fungsi tersebut.

Tanda tangan:

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

RuntimeOptions.timeoutSeconds

Batas waktu untuk fungsi dalam hitungan detik, nilai yang mungkin adalah 0 hingga 540.

Tanda tangan:

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

RuntimeOptions.vpcConnector

Hubungkan fungsi cloud ke konektor VPC yang ditentukan.

Tanda tangan:

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

RuntimeOptions.vpcConnectorEgressSettings

Pengaturan jalan keluar untuk konektor VPC.

Tanda tangan:

vpcConnectorEgressSettings?: (typeof VPC_EGRESS_SETTINGS_OPTIONS)[number] | ResetValue;