Opsi yang dapat ditetapkan pada fungsi HTTPS onRequest.
Tanda Tangan:
export interface HttpsOptions extends Omit<GlobalOptions, "region">
Memperluas: Hilangkan<GlobalOptions, "region">
Properti
Properti | Jenis | Deskripsi |
---|---|---|
serentak | angka | Ekspresi<angka> | NilaiReset | Jumlah permintaan yang dapat ditayangkan oleh fungsi sekaligus. |
cors | rangkaian | boolean | RegExp | Array<string | Ekspresi reguler> | Jika true (benar), izinkan CORS pada permintaan ke fungsi ini. Jika ini adalah string atau RegExp , permintaan dari domain yang cocok dengan nilai yang diberikan akan diizinkan. Jika ini adalah Array , permintaan dari domain yang cocok dengan setidaknya satu entri array akan diizinkan. Ditetapkan secara default ke true untuk https.CallableFunction dan false jika tidak. |
cpu | angka | "gcf_gen1" | Jumlah pecahan CPU yang akan dialokasikan ke suatu fungsi. |
Setelan masuk | options.IngressSetting | NilaiReset | Setelan masuk yang mengontrol tempat asal fungsi ini dapat dipanggil. |
pemanggil | "publik" | "pribadi" | rangkaian | {i>string<i}[] | Invoker untuk menyetel 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 akan dijalankan secara paralel. |
memori | options.MemoryOption | Ekspresi<angka> | NilaiReset | Jumlah memori yang akan dialokasikan ke suatu fungsi. |
minInstances | angka | Ekspresi<angka> | NilaiReset | Jumlah minimum instance sebenarnya yang akan berjalan pada waktu tertentu. |
hapus | boolean | Ekspresi<boolean> | Jika true (benar), jangan men-deploy atau mengemulasi fungsi ini. |
region | DidukungRegion | rangkaian | Array<supportedRegion | {i>string<i}> | Ekspresi<string> | NilaiReset | Fungsi HTTP dapat menggantikan opsi global dan dapat menentukan beberapa region yang menjadi tujuan deployment. |
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 cloud function ke konektor VPC yang ditentukan. |
vpcConnectorEgressSettings | options.VpcEgressSetting | NilaiReset | Setelan traffic keluar untuk konektor VPC. |
https.HttpsOptions.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;
https.HttpsOptions.cors
Jika true (benar), izinkan CORS pada permintaan ke fungsi ini. Jika ini adalah string
atau RegExp
, permintaan dari domain yang cocok dengan nilai yang diberikan akan diizinkan. Jika ini adalah Array
, permintaan dari domain yang cocok dengan setidaknya satu entri array akan diizinkan. Ditetapkan secara default ke true untuk https.CallableFunction dan false jika tidak.
Tanda Tangan:
cors?: string | boolean | RegExp | Array<string | RegExp>;
https.HttpsOptions.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";
https.HttpsOptions.ingressSettings
Setelan masuk yang mengontrol tempat asal fungsi ini dapat dipanggil.
Tanda Tangan:
ingressSettings?: options.IngressSetting | ResetValue;
https.HttpsOptions.invoker
Invoker untuk menyetel kontrol akses pada fungsi HTTPS.
Tanda Tangan:
invoker?: "public" | "private" | string | string[];
https.HttpsOptions.labels
Label pengguna yang akan ditetapkan pada fungsi.
Tanda Tangan:
labels?: Record<string, string>;
https.HttpsOptions.maxInstances
Jumlah instance maksimum yang akan dijalankan secara paralel.
Tanda Tangan:
maxInstances?: number | Expression<number> | ResetValue;
https.HttpsOptions.memory
Jumlah memori yang akan dialokasikan ke suatu fungsi.
Tanda Tangan:
memory?: options.MemoryOption | Expression<number> | ResetValue;
https.HttpsOptions.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.
Tanda Tangan:
minInstances?: number | Expression<number> | ResetValue;
https.HttpsOptions.omit
Jika true (benar), jangan men-deploy atau mengemulasi fungsi ini.
Tanda Tangan:
omit?: boolean | Expression<boolean>;
https.HttpsOptions.region
Fungsi HTTP dapat menggantikan opsi global dan dapat menentukan beberapa region yang menjadi tujuan deployment.
Tanda Tangan:
region?: SupportedRegion | string | Array<SupportedRegion | string> | Expression<string> | ResetValue;
https.HttpsOptions.secrets
Tanda Tangan:
secrets?: (string | SecretParam)[];
https.HttpsOptions.serviceAccount
Akun layanan tertentu yang akan digunakan untuk menjalankan fungsi.
Tanda Tangan:
serviceAccount?: string | Expression<string> | ResetValue;
https.HttpsOptions.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 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 dtk (30 menit)
Tanda Tangan:
timeoutSeconds?: number | Expression<number> | ResetValue;
https.HttpsOptions.vpcConnector
Menghubungkan cloud function ke konektor VPC yang ditentukan.
Tanda Tangan:
vpcConnector?: string | Expression<string> | ResetValue;
https.HttpsOptions.vpcConnectorEgressSettings
Setelan traffic keluar untuk konektor VPC.
Tanda Tangan:
vpcConnectorEgressSettings?: options.VpcEgressSetting | ResetValue;