GlobalOptions interface

GlobalOptions เป็นตัวเลือกที่สามารถตั้งค่าได้ทั่วทั้งโครงการ ตัวเลือกเหล่านี้เป็นเรื่องปกติสำหรับ HTTPS และฟังก์ชันการจัดการเหตุการณ์

ลายเซ็น:

export interface GlobalOptions 

คุณสมบัติ

GlobalOptions.การทำงานพร้อมกัน

จำนวนคำขอที่ฟังก์ชันสามารถให้บริการได้ในคราวเดียว

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

ลายเซ็น:

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

GlobalOptions.cpu

จำนวนเศษส่วนของ CPU ที่จะจัดสรรให้กับฟังก์ชัน

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

ลายเซ็น:

cpu?: number | "gcf_gen1";

GlobalOptions.enforceAppCheck

กำหนดว่าจะบังคับใช้ Firebase App Check หรือไม่ ค่าเริ่มต้นเป็นเท็จ

เมื่อเป็นจริง คำขอที่มีโทเค็นไม่ถูกต้องจะตอบกลับอัตโนมัติด้วยข้อผิดพลาด 401 (ไม่ได้รับอนุญาต) เมื่อเป็นเท็จ คำขอที่มีโทเค็นไม่ถูกต้องจะตั้ง event.app เป็น undefined .

ลายเซ็น:

enforceAppCheck?: boolean;

GlobalOptions.ingressSettings

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

ลายเซ็น:

ingressSettings?: IngressSetting | ResetValue;

GlobalOptions.ผู้เรียก

ผู้เรียกใช้เพื่อตั้งค่าการควบคุมการเข้าถึงฟังก์ชัน HTTPS

ลายเซ็น:

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

GlobalOptions.ป้ายกำกับ

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

ลายเซ็น:

labels?: Record<string, string>;

GlobalOptions.maxInstances

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

ลายเซ็น:

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

GlobalOptions.หน่วยความจำ

จำนวนหน่วยความจำที่จะจัดสรรให้กับฟังก์ชัน

ลายเซ็น:

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

GlobalOptions.minInstances

จำนวนอินสแตนซ์จริงขั้นต่ำที่จะเรียกใช้ในช่วงเวลาที่กำหนด

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

ลายเซ็น:

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

GlobalOptions.ละเว้น

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

ลายเซ็น:

omit?: boolean | Expression<boolean>;

GlobalOptions.preserveExternalChanges

ควบคุมว่าการกำหนดค่าฟังก์ชันที่แก้ไขภายนอกแหล่งฟังก์ชันจะยังคงอยู่หรือไม่ ค่าเริ่มต้นเป็นเท็จ

เมื่อตั้งค่าการกำหนดค่าให้พร้อมใช้งานในแพลตฟอร์มพื้นฐานที่ยังไม่มีใน Firebase SDK สำหรับฟังก์ชันคลาวด์ เราขอแนะนำให้ตั้งค่า preserveExternalChanges เป็น true . มิฉะนั้น เมื่อ Google เปิดตัว SDK เวอร์ชันใหม่ที่รองรับการกำหนดค่าที่ขาดหายไป การตั้งค่าที่กำหนดค่าด้วยตนเองของฟังก์ชันของคุณอาจถูกลบออกโดยไม่ตั้งใจ

ลายเซ็น:

preserveExternalChanges?: boolean;

GlobalOptions.ภูมิภาค

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

ลายเซ็น:

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

GlobalOptions.ความลับ

ลายเซ็น:

secrets?: (string | SecretParam)[];

GlobalOptions.serviceAccount

บัญชีบริการเฉพาะสำหรับฟังก์ชันการทำงาน

ลายเซ็น:

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

GlobalOptions.timeoutSeconds

หมดเวลาสำหรับฟังก์ชันเป็นวินาที ค่าที่เป็นไปได้คือ 0 ถึง 540 ฟังก์ชัน HTTPS สามารถระบุการหมดเวลาที่สูงขึ้นได้

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

ลายเซ็น:

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

GlobalOptions.vpcConnector

เชื่อมต่อฟังก์ชันกับตัวเชื่อมต่อ VPC ที่ระบุ

ลายเซ็น:

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

GlobalOptions.vpcConnectorEgressSettings

การตั้งค่า Egress สำหรับตัวเชื่อมต่อ VPC

ลายเซ็น:

vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;