GlobalOptions interface

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

ลายเซ็น:

export interface GlobalOptions 

คุณสมบัติ

GlobalOptions.concurrency

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

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

ลายเซ็น:

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

GlobalOptions.cpu

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

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

ลายเซ็น:

cpu?: number | "gcf_gen1";

GlobalOptions.enforceAppCheck

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

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

ลายเซ็น:

enforceAppCheck?: boolean;

GlobalOptions.ingressSettings

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

ลายเซ็น:

ingressSettings?: IngressSetting | ResetValue;

GlobalOptions.invoker

Invoker เพื่อตั้งค่าการควบคุมการเข้าถึงในฟังก์ชัน https

ลายเซ็น:

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

GlobalOptions.labels

ป้ายกำกับผู้ใช้เพื่อตั้งค่าในฟังก์ชัน

ลายเซ็น:

labels?: Record<string, string>;

GlobalOptions.maxInstances

จำนวนอินสแตนซ์สูงสุดที่จะรันพร้อมกัน

ลายเซ็น:

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

GlobalOptions.memory

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

ลายเซ็น:

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

อินสแตนซ์ GlobalOptions.min

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

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

ลายเซ็น:

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

GlobalOptions.omit

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

ลายเซ็น:

omit?: boolean | Expression<boolean>;

GlobalOptions รักษาการเปลี่ยนแปลงภายนอก

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

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

ลายเซ็น:

preserveExternalChanges?: boolean;

GlobalOptions.region

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

ลายเซ็น:

region?: SupportedRegion | string;

GlobalOptions.ความลับ

ลายเซ็น:

secrets?: (string | SecretParam)[];

GlobalOptions.serviceAccount

บัญชีบริการเฉพาะสำหรับฟังก์ชันที่จะเรียกใช้เป็น

ลายเซ็น:

serviceAccount?: string | ResetValue;

GlobalOptions.timeout วินาที

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

การหมดเวลาขั้นต่ำสำหรับฟังก์ชัน gen 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

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

ลายเซ็น:

vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;