alerts.FirebaseAlertOptions interface

การกำหนดค่าสำหรับฟังก์ชันการแจ้งเตือนของ Firebase

ลายเซ็น:

export interface FirebaseAlertOptions extends options.EventHandlerOptions 

ขยาย: options.EventHandlerOptions

พร็อพเพอร์ตี้

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

notifications.FirebaseAlertOptions.alertType

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

ลายเซ็น:

alertType: AlertType;

notifications.FirebaseAlertOptions.appId

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

ลายเซ็น:

appId?: string;

notifications.FirebaseAlertOptions.concurrency

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

ลายเซ็น:

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

notifications.FirebaseAlertOptions.cpu

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

ลายเซ็น:

cpu?: number | "gcf_gen1";

notifications.FirebaseAlertOptions.ingressSettings

การตั้งค่าข้อมูลขาเข้าซึ่งควบคุมว่าจะเรียกใช้ฟังก์ชันนี้จากที่ใด ค่า Null จะปิดการตั้งค่าขาเข้า

ลายเซ็น:

ingressSettings?: options.IngressSetting | ResetValue;

notifications.FirebaseAlertOptions.labels

ป้ายกำกับของผู้ใช้ที่จะตั้งค่าในฟังก์ชัน

ลายเซ็น:

labels?: Record<string, string>;

notifications.FirebaseAlertOptions.maxInstances

จำนวนอินสแตนซ์สูงสุดที่จะเรียกใช้พร้อมกัน ค่าของ null จะคืนค่าอินสแตนซ์สูงสุดเริ่มต้น

ลายเซ็น:

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

notifications.FirebaseAlertOptions.memory

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

ลายเซ็น:

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

notifications.FirebaseAlertOptions.minInstances

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

ลายเซ็น:

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

notifications.FirebaseAlertOptions.omit

หากเป็น "จริง" โปรดอย่าติดตั้งใช้งานหรือจำลองฟังก์ชันนี้

ลายเซ็น:

omit?: boolean | Expression<boolean>;

notifications.FirebaseAlertOptions.region

ภูมิภาคที่ควรทำให้ฟังก์ชันใช้งานได้

ลายเซ็น:

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

notifications.FirebaseAlertOptions.retry

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

ลายเซ็น:

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

notifications.FirebaseAlertOptions.secrets

ลายเซ็น:

secrets?: (string | SecretParam)[];

notifications.FirebaseAlertOptions.serviceAccount

บัญชีบริการที่เจาะจงให้ฟังก์ชันเรียกใช้ ค่า Null จะกู้คืนบัญชีบริการเริ่มต้น

ลายเซ็น:

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

notifications.FirebaseAlertOptions.timeoutSeconds

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

ลายเซ็น:

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

notifications.FirebaseAlertOptions.vpcConnector

เชื่อมต่อ Cloud Function กับเครื่องมือเชื่อมต่อ VPC ที่ระบุ ค่า Null จะนำเครื่องมือเชื่อมต่อ VPC ออก

ลายเซ็น:

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

notifications.FirebaseAlertOptions.vpcConnectorEgressSettings

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

ลายเซ็น:

vpcConnectorEgressSettings?: options.VpcEgressSetting | ResetValue;