GlobalOptions interface

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

ลายเซ็น:

export interface GlobalOptions 

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

GlobalOptions.concurrency

จำนวนคำขอที่ฟังก์ชันหนึ่งแสดงพร้อมกันได้

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

ลายเซ็น:

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

GlobalOptions.cpu

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

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

ลายเซ็น:

cpu?: number | "gcf_gen1";

GlobalOptions.enforceAppCheck

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

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

ลายเซ็น:

enforceAppCheck?: boolean;

GlobalOptions.ingressSettings

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

ลายเซ็น:

ingressSettings?: IngressSetting | ResetValue;

GlobalOptions.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.minInstances

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

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

ลายเซ็น:

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

GlobalOptions.omit

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

ลายเซ็น:

omit?: boolean | Expression<boolean>;

GlobalOptions.preserveExternalChanges

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

เมื่อตั้งค่าการกำหนดค่าที่ใช้ได้ในแพลตฟอร์มที่สำคัญซึ่งยังไม่พร้อมใช้งานใน Firebase SDK สำหรับ Cloud Functions เราขอแนะนำให้ตั้งค่า preserveExternalChanges เป็น true มิเช่นนั้น เมื่อ Google เผยแพร่ SDK เวอร์ชันใหม่ที่รองรับการกำหนดค่าที่ขาดหายไป ระบบอาจล้างข้อมูลการตั้งค่าที่กําหนดด้วยตนเองของฟังก์ชันออกโดยไม่ได้ตั้งใจ

ลายเซ็น:

preserveExternalChanges?: boolean;

GlobalOptions.region

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

ลายเซ็น:

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

GlobalOptions.secrets

ลายเซ็น:

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

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

ลายเซ็น:

vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;