alerts.FirebaseAlertOptions interface

Konfigurasi untuk fungsi Pemberitahuan Firebase.

Tanda Tangan:

export interface FirebaseAlertOptions extends options.EventHandlerOptions 

Memperluas: options.EventHandlerOptions

Properti

Properti Jenis Deskripsi
alertType AlertType Menentukan cakupan pengendali yang akan dipicu pada jenis pemberitahuan.
appId string Mencakup fungsi yang akan dipicu pada aplikasi tertentu.
serentak angka | Ekspresi<angka> | NilaiReset Jumlah permintaan yang dapat ditayangkan oleh fungsi sekaligus. Hanya dapat diterapkan ke fungsi yang berjalan di Cloud Functions v2. 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.
cpu angka | "gcf_gen1" 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 dalam Google Cloud Functions generasi 1. Untuk mengembalikan ke jumlah CPU yang digunakan di gcloud atau di Cloud Functions generasi 1, tetapkan nilai ini ke nilai "gcf_gen1"
Setelan masuk options.IngressSetting | NilaiReset Setelan masuk yang mengontrol tempat asal fungsi ini dapat dipanggil. Nilai null akan menonaktifkan setelan masuk.
label Rekam<string, string> Label pengguna yang akan ditetapkan pada fungsi.
maxInstances angka | Ekspresi<angka> | NilaiReset Jumlah instance maksimum yang akan dijalankan secara paralel. Nilai null akan memulihkan instance maksimum default.
memori options.MemoryOption | Ekspresi<angka> | NilaiReset Jumlah memori yang akan dialokasikan ke suatu fungsi. Nilai null akan memulihkan ukuran default 256 MB.
minInstances angka | Ekspresi<angka> | NilaiReset Jumlah minimum instance sebenarnya yang akan berjalan pada waktu tertentu. Instance akan dikenai biaya untuk alokasi memori dan 10% alokasi CPU saat tidak ada aktivitas. Nilai null akan memulihkan instance min default.
hapus boolean | Ekspresi<boolean> Jika true (benar), jangan men-deploy atau mengemulasi fungsi ini.
region options.DidukungRegion | rangkaian | Ekspresi<string> | NilaiReset Region tempat fungsi harus di-deploy.
coba lagi boolean | Ekspresi<boolean> | NilaiReset Apakah eksekusi yang gagal harus dikirim lagi.
rahasia (string | SecretParam)[]
akunlayanan rangkaian | Ekspresi<string> | NilaiReset Akun layanan tertentu yang akan digunakan untuk menjalankan fungsi. Nilai null akan memulihkan akun layanan default.
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. Nilai null memulihkan default 60s Waktu tunggu minimum untuk fungsi gen 2 adalah 1s. 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)
vpcConnector rangkaian | Ekspresi<string> | NilaiReset Menghubungkan cloud function ke konektor VPC yang ditentukan. Nilai null akan menghapus konektor VPC
vpcConnectorEgressSettings options.VpcEgressSetting | NilaiReset Setelan traffic keluar untuk konektor VPC. Nilai null akan menonaktifkan setelan traffic keluar konektor VPC

alerts.FirebaseAlertOptions.alertType

Menentukan cakupan pengendali yang akan dipicu pada jenis pemberitahuan.

Tanda Tangan:

alertType: AlertType;

alerts.FirebaseAlertOptions.appId

Mencakup fungsi yang akan dipicu pada aplikasi tertentu.

Tanda Tangan:

appId?: string;

alerts.FirebaseAlertOptions.concurrency

Jumlah permintaan yang dapat ditayangkan oleh fungsi sekaligus. Hanya dapat diterapkan ke fungsi yang berjalan di Cloud Functions v2. 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;

alerts.FirebaseAlertOptions.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 dalam Google Cloud Functions generasi 1. Untuk mengembalikan ke jumlah CPU yang digunakan di gcloud atau di Cloud Functions generasi 1, tetapkan nilai ini ke nilai "gcf_gen1"

Tanda Tangan:

cpu?: number | "gcf_gen1";

alerts.FirebaseAlertOptions.ingressSettings

Setelan masuk yang mengontrol tempat asal fungsi ini dapat dipanggil. Nilai null akan menonaktifkan setelan masuk.

Tanda Tangan:

ingressSettings?: options.IngressSetting | ResetValue;

alerts.FirebaseAlertOptions.labels

Label pengguna yang akan ditetapkan pada fungsi.

Tanda Tangan:

labels?: Record<string, string>;

alerts.FirebaseAlertOptions.maxInstances

Jumlah instance maksimum yang akan dijalankan secara paralel. Nilai null akan memulihkan instance maksimum default.

Tanda Tangan:

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

alerts.FirebaseAlertOptions.memory

Jumlah memori yang akan dialokasikan ke suatu fungsi. Nilai null akan memulihkan ukuran default 256 MB.

Tanda Tangan:

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

alerts.FirebaseAlertOptions.minInstances

Jumlah minimum instance sebenarnya yang akan berjalan pada waktu tertentu. Instance akan dikenai biaya untuk alokasi memori dan 10% alokasi CPU saat tidak ada aktivitas. Nilai null akan memulihkan instance min default.

Tanda Tangan:

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

alerts.FirebaseAlertOptions.omit

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

Tanda Tangan:

omit?: boolean | Expression<boolean>;

alerts.FirebaseAlertOptions.region

Region tempat fungsi harus di-deploy.

Tanda Tangan:

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

alerts.FirebaseAlertOptions.retry

Apakah eksekusi yang gagal harus dikirim lagi.

Tanda Tangan:

retry?: boolean | Expression<boolean> | ResetValue;

alerts.FirebaseAlertOptions.secrets

Tanda Tangan:

secrets?: (string | SecretParam)[];

alerts.FirebaseAlertOptions.serviceAccount

Akun layanan tertentu yang akan digunakan untuk menjalankan fungsi. Nilai null akan memulihkan akun layanan default.

Tanda Tangan:

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

alerts.FirebaseAlertOptions.timeoutSeconds

Waktu tunggu untuk fungsi dalam detik, nilai yang mungkin adalah 0 hingga 540. Fungsi HTTPS dapat menentukan waktu tunggu yang lebih tinggi. Nilai null memulihkan default 60s Waktu tunggu minimum untuk fungsi gen 2 adalah 1s. 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 dtk (30 menit)

Tanda Tangan:

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

alerts.FirebaseAlertOptions.vpcConnector

Menghubungkan cloud function ke konektor VPC yang ditentukan. Nilai null akan menghapus konektor VPC

Tanda Tangan:

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

alerts.FirebaseAlertOptions.vpcConnectorEgressSettings

Setelan traffic keluar untuk konektor VPC. Nilai null akan menonaktifkan setelan traffic keluar konektor VPC

Tanda Tangan:

vpcConnectorEgressSettings?: options.VpcEgressSetting | ResetValue;