alerts.FirebaseAlertOptions interface

การกำหนดค่าสำหรับฟังก์ชัน Firebase Alert

ลายเซ็น:

export interface FirebaseAlertOptions extends options.EventHandlerOptions 

ขยาย: options.EventHandlerOptions

คุณสมบัติ

คุณสมบัติ พิมพ์ คำอธิบาย
ประเภทการแจ้งเตือน ประเภทการแจ้งเตือน กำหนดขอบเขตตัวจัดการเพื่อทริกเกอร์ประเภทการแจ้งเตือน
รหัสแอป เชือก กำหนดขอบเขตฟังก์ชันเพื่อทริกเกอร์ในแอปพลิเคชันเฉพาะ
เห็นพ้องต้องกัน หมายเลข | การแสดงออก <จำนวน> | รีเซ็ตค่า จำนวนคำขอที่ฟังก์ชันสามารถให้บริการได้ในคราวเดียว ใช้ได้กับฟังก์ชันที่ทำงานบน Cloud Functions v2 เท่านั้น ค่า null จะคืนค่าการทำงานพร้อมกันเริ่มต้น (80 เมื่อ CPU > = 1, 1 อย่างอื่น) ไม่สามารถตั้งค่าการทำงานพร้อมกันเป็นค่าอื่นนอกเหนือจาก 1 ได้ หาก cpu น้อยกว่า 1 ค่าสูงสุดสำหรับการทำงานพร้อมกันคือ 1,000
ซีพียู หมายเลข | "gcf_gen1" จำนวนเศษส่วนของ CPU ที่จะจัดสรรให้กับฟังก์ชัน ค่าเริ่มต้นคือ 1 สำหรับฟังก์ชันที่มี < = RAM 2GB และเพิ่มขึ้นตามขนาดหน่วยความจำที่ใหญ่ขึ้น สิ่งนี้แตกต่างจากค่าเริ่มต้นเมื่อใช้ยูทิลิตี gcloud และแตกต่างจากจำนวนคงที่ที่กำหนดในฟังก์ชัน Google Cloud รุ่นที่ 1 หากต้องการเปลี่ยนกลับเป็นจำนวน CPU ที่ใช้ใน gcloud หรือใน Cloud Functions รุ่นที่ 1 ให้ตั้งค่านี้เป็นค่า "gcf_gen1"
การตั้งค่าทางเข้า options.IngressSetting | รีเซ็ตค่า การตั้งค่า Ingress ซึ่งควบคุมตำแหน่งที่สามารถเรียกใช้ฟังก์ชันนี้ได้ ค่าว่างจะปิดการตั้งค่าทางเข้า
ฉลาก บันทึก<string, string> ป้ายกำกับผู้ใช้สำหรับตั้งค่าฟังก์ชัน
อินสแตนซ์สูงสุด หมายเลข | การแสดงออก <จำนวน> | รีเซ็ตค่า จำนวนอินสแตนซ์สูงสุดที่จะทำงานแบบขนาน ค่าว่างจะคืนค่าอินสแตนซ์สูงสุดเริ่มต้น
หน่วยความจำ options.MemoryOption | การแสดงออก <จำนวน> | รีเซ็ตค่า จำนวนหน่วยความจำที่จะจัดสรรให้กับฟังก์ชัน ค่า null จะคืนค่าเริ่มต้นที่ 256MB
minInstances หมายเลข | การแสดงออก <จำนวน> | รีเซ็ตค่า จำนวนอินสแตนซ์จริงขั้นต่ำที่จะเรียกใช้ในเวลาที่กำหนด อินสแตนซ์จะถูกเรียกเก็บเงินสำหรับการจัดสรรหน่วยความจำและการจัดสรร CPU 10% ขณะที่ไม่ได้ใช้งาน ค่า null จะคืนค่าอินสแตนซ์ min เริ่มต้น
ละเว้น บูลีน | การแสดงออก <บูลีน> หากเป็นจริง ห้ามปรับใช้หรือจำลองฟังก์ชันนี้
ภูมิภาค ตัวเลือกภูมิภาคที่รองรับ | สตริง | การแสดงออก <สตริง> | รีเซ็ตค่า ภูมิภาคที่ควรปรับใช้ฟังก์ชันต่างๆ
ลองอีกครั้ง บูลีน | การแสดงออก <บูลีน> | รีเซ็ตค่า ควรส่งการดำเนินการที่ล้มเหลวอีกครั้งหรือไม่
ความลับ (สตริง | SecretParam)[]
บัญชีบริการ สตริง | การแสดงออก <สตริง> | รีเซ็ตค่า บัญชีบริการเฉพาะสำหรับฟังก์ชันที่จะเรียกใช้ ค่าว่างจะคืนค่าบัญชีบริการเริ่มต้น
หมดเวลาวินาที หมายเลข | การแสดงออก <จำนวน> | รีเซ็ตค่า หมดเวลาสำหรับฟังก์ชันเป็นวินาที ค่าที่เป็นไปได้คือ 0 ถึง 540 ฟังก์ชัน HTTPS สามารถระบุการหมดเวลาที่สูงขึ้นได้ ค่าว่างจะคืนค่าค่าเริ่มต้นที่ 60 วินาที การหมดเวลาขั้นต่ำสำหรับฟังก์ชันรุ่นที่ 2 คือ 1 วินาที การหมดเวลาสูงสุดสำหรับฟังก์ชันขึ้นอยู่กับประเภทของฟังก์ชัน: ฟังก์ชันการจัดการเหตุการณ์มีการหมดเวลาสูงสุด 540 วินาที (9 นาที) HTTPS และฟังก์ชันที่เรียกได้จะมีระยะหมดเวลาสูงสุด 36,00 วินาที (1 ชั่วโมง) ฟังก์ชันคิวงานมีการหมดเวลาสูงสุด 1,800 วินาที (30 นาที)
vpcConnector สตริง | การแสดงออก <สตริง> | รีเซ็ตค่า เชื่อมต่อฟังก์ชันคลาวด์กับตัวเชื่อมต่อ VPC ที่ระบุ ค่าว่างจะนำตัวเชื่อมต่อ VPC ออก
การตั้งค่า vpcConnectorEgress options.VpcEgressSetting | รีเซ็ตค่า การตั้งค่า Egress สำหรับตัวเชื่อมต่อ VPC ค่าว่างจะปิดการตั้งค่าขาออกของตัวเชื่อมต่อ VPC

alerts.FirebaseAlertOptions.alertType

กำหนดขอบเขตตัวจัดการเพื่อทริกเกอร์ประเภทการแจ้งเตือน

ลายเซ็น:

alertType: AlertType;

alerts.FirebaseAlertOptions.appId

กำหนดขอบเขตฟังก์ชันเพื่อทริกเกอร์ในแอปพลิเคชันเฉพาะ

ลายเซ็น:

appId?: string;

alerts.FirebaseAlertOptions.ภาวะพร้อมกัน

จำนวนคำขอที่ฟังก์ชันสามารถให้บริการได้ในคราวเดียว ใช้ได้กับฟังก์ชันที่ทำงานบน Cloud Functions v2 เท่านั้น ค่า null จะคืนค่าการทำงานพร้อมกันเริ่มต้น (80 เมื่อ CPU > = 1, 1 อย่างอื่น) ไม่สามารถตั้งค่าการทำงานพร้อมกันเป็นค่าอื่นนอกเหนือจาก 1 ได้ หาก cpu น้อยกว่า 1 ค่าสูงสุดสำหรับการทำงานพร้อมกันคือ 1,000

ลายเซ็น:

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

alerts.FirebaseAlertOptions.cpu

จำนวนเศษส่วนของ CPU ที่จะจัดสรรให้กับฟังก์ชัน ค่าเริ่มต้นคือ 1 สำหรับฟังก์ชันที่มี < = RAM 2GB และเพิ่มขึ้นตามขนาดหน่วยความจำที่ใหญ่ขึ้น สิ่งนี้แตกต่างจากค่าเริ่มต้นเมื่อใช้ยูทิลิตี gcloud และแตกต่างจากจำนวนคงที่ที่กำหนดในฟังก์ชัน Google Cloud รุ่นที่ 1 หากต้องการเปลี่ยนกลับเป็นจำนวน CPU ที่ใช้ใน gcloud หรือใน Cloud Functions รุ่นที่ 1 ให้ตั้งค่านี้เป็นค่า "gcf_gen1"

ลายเซ็น:

cpu?: number | "gcf_gen1";

alerts.FirebaseAlertOptions.ingressSettings

การตั้งค่า Ingress ซึ่งควบคุมตำแหน่งที่สามารถเรียกใช้ฟังก์ชันนี้ได้ ค่าว่างจะปิดการตั้งค่าทางเข้า

ลายเซ็น:

ingressSettings?: options.IngressSetting | ResetValue;

alerts.FirebaseAlertOptions.labels

ป้ายกำกับผู้ใช้สำหรับตั้งค่าฟังก์ชัน

ลายเซ็น:

labels?: Record<string, string>;

alerts.FirebaseAlertOptions.maxInstances

จำนวนอินสแตนซ์สูงสุดที่จะทำงานแบบขนาน ค่าว่างจะคืนค่าอินสแตนซ์สูงสุดเริ่มต้น

ลายเซ็น:

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

alerts.FirebaseAlertOptions.หน่วยความจำ

จำนวนหน่วยความจำที่จะจัดสรรให้กับฟังก์ชัน ค่า null จะคืนค่าเริ่มต้นที่ 256MB

ลายเซ็น:

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

alerts.FirebaseAlertOptions.minInstances

จำนวนอินสแตนซ์จริงขั้นต่ำที่จะเรียกใช้ในเวลาที่กำหนด อินสแตนซ์จะถูกเรียกเก็บเงินสำหรับการจัดสรรหน่วยความจำและการจัดสรร CPU 10% ขณะที่ไม่ได้ใช้งาน ค่า null จะคืนค่าอินสแตนซ์ min เริ่มต้น

ลายเซ็น:

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

alerts.FirebaseAlertOptions.ละเว้น

หากเป็นจริง ห้ามปรับใช้หรือจำลองฟังก์ชันนี้

ลายเซ็น:

omit?: boolean | Expression<boolean>;

alerts.FirebaseAlertOptions.ภูมิภาค

ภูมิภาคที่ควรปรับใช้ฟังก์ชันต่างๆ

ลายเซ็น:

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

alerts.FirebaseAlertOptions.ลองอีกครั้ง

ควรส่งการดำเนินการที่ล้มเหลวอีกครั้งหรือไม่

ลายเซ็น:

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

alerts.FirebaseAlertOptions.secrets

ลายเซ็น:

secrets?: (string | SecretParam)[];

alerts.FirebaseAlertOptions.serviceAccount

บัญชีบริการเฉพาะสำหรับฟังก์ชันที่จะเรียกใช้ ค่าว่างจะคืนค่าบัญชีบริการเริ่มต้น

ลายเซ็น:

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

alerts.FirebaseAlertOptions.timeoutSeconds

หมดเวลาสำหรับฟังก์ชันเป็นวินาที ค่าที่เป็นไปได้คือ 0 ถึง 540 ฟังก์ชัน HTTPS สามารถระบุการหมดเวลาที่สูงขึ้นได้ ค่าว่างจะคืนค่าค่าเริ่มต้นที่ 60 วินาที การหมดเวลาขั้นต่ำสำหรับฟังก์ชันรุ่นที่ 2 คือ 1 วินาที การหมดเวลาสูงสุดสำหรับฟังก์ชันขึ้นอยู่กับประเภทของฟังก์ชัน: ฟังก์ชันการจัดการเหตุการณ์มีการหมดเวลาสูงสุด 540 วินาที (9 นาที) HTTPS และฟังก์ชันที่เรียกได้จะมีระยะหมดเวลาสูงสุด 36,00 วินาที (1 ชั่วโมง) ฟังก์ชันคิวงานมีการหมดเวลาสูงสุด 1,800 วินาที (30 นาที)

ลายเซ็น:

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

alerts.FirebaseAlertOptions.vpcConnector

เชื่อมต่อฟังก์ชันคลาวด์กับตัวเชื่อมต่อ VPC ที่ระบุ ค่าว่างจะนำตัวเชื่อมต่อ VPC ออก

ลายเซ็น:

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

alerts.FirebaseAlertOptions.vpcConnectorEgressSettings

การตั้งค่า Egress สำหรับตัวเชื่อมต่อ VPC ค่าว่างจะปิดการตั้งค่าขาออกของตัวเชื่อมต่อ VPC

ลายเซ็น:

vpcConnectorEgressSettings?: options.VpcEgressSetting | ResetValue;