https.HttpsOptions interface

ตัวเลือกที่สามารถตั้งค่าได้ในฟังก์ชัน onRequest HTTPS

ลายเซ็น:

export interface HttpsOptions extends Omit<GlobalOptions, "region"> 

ขยาย: ละเว้น < GlobalOptions , "ภูมิภาค">

คุณสมบัติ

คุณสมบัติ พิมพ์ คำอธิบาย
เห็นพ้องต้องกัน หมายเลข | การแสดงออก <จำนวน> | รีเซ็ตค่า จำนวนคำขอที่ฟังก์ชันสามารถให้บริการได้ในคราวเดียว
คอร์ สตริง | บูลีน | RegExp | อาร์เรย์<สตริง | RegExp> ถ้าเป็นจริง อนุญาตให้ CORS ร้องขอฟังก์ชันนี้ หากนี่คือ string หรือ RegExp จะอนุญาตคำขอจากโดเมนที่ตรงกับค่าที่ระบุ หากนี่คือ Array จะอนุญาตคำขอจากโดเมนที่ตรงกับรายการอาร์เรย์อย่างน้อยหนึ่งรายการ ค่าเริ่มต้นเป็นจริงสำหรับ https.CallableFunction และเท็จอย่างอื่น
ซีพียู หมายเลข | "gcf_gen1" จำนวนเศษส่วนของ CPU ที่จะจัดสรรให้กับฟังก์ชัน
การตั้งค่าทางเข้า options.IngressSetting | รีเซ็ตค่า การตั้งค่า Ingress ซึ่งควบคุมตำแหน่งที่สามารถเรียกใช้ฟังก์ชันนี้ได้
ผู้เรียก "สาธารณะ" | "ส่วนตัว" | สตริง | สตริง[] ผู้เรียกใช้เพื่อตั้งค่าการควบคุมการเข้าถึงฟังก์ชัน https
ฉลาก บันทึก<string, string> ป้ายกำกับผู้ใช้สำหรับตั้งค่าฟังก์ชัน
อินสแตนซ์สูงสุด หมายเลข | การแสดงออก <จำนวน> | รีเซ็ตค่า จำนวนอินสแตนซ์สูงสุดที่จะทำงานแบบขนาน
หน่วยความจำ options.MemoryOption | การแสดงออก <จำนวน> | รีเซ็ตค่า จำนวนหน่วยความจำที่จะจัดสรรให้กับฟังก์ชัน
minInstances หมายเลข | การแสดงออก <จำนวน> | รีเซ็ตค่า จำนวนอินสแตนซ์จริงขั้นต่ำที่จะเรียกใช้ในเวลาที่กำหนด
ละเว้น บูลีน | การแสดงออก <บูลีน> หากเป็นจริง ห้ามปรับใช้หรือจำลองฟังก์ชันนี้
ภูมิภาค รองรับภูมิภาค | สตริง | อาร์เรย์ < ภูมิภาคที่รองรับ | สตริง> | การแสดงออก <สตริง> | รีเซ็ตค่า ฟังก์ชัน HTTP สามารถแทนที่ตัวเลือกส่วนกลางและสามารถระบุหลายภูมิภาคเพื่อปรับใช้ได้
ความลับ (สตริง | SecretParam)[]
บัญชีบริการ สตริง | การแสดงออก <สตริง> | รีเซ็ตค่า บัญชีบริการเฉพาะสำหรับฟังก์ชันการทำงาน
หมดเวลาวินาที หมายเลข | การแสดงออก <จำนวน> | รีเซ็ตค่า หมดเวลาสำหรับฟังก์ชันเป็นวินาที ค่าที่เป็นไปได้คือ 0 ถึง 540 ฟังก์ชัน HTTPS สามารถระบุการหมดเวลาที่สูงขึ้นได้
vpcConnector สตริง | การแสดงออก <สตริง> | รีเซ็ตค่า เชื่อมต่อฟังก์ชันคลาวด์กับตัวเชื่อมต่อ VPC ที่ระบุ
การตั้งค่า vpcConnectorEgress options.VpcEgressSetting | รีเซ็ตค่า การตั้งค่า Egress สำหรับตัวเชื่อมต่อ VPC

https.HttpsOptions.concurrency

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

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

ลายเซ็น:

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

https.HttpsOptions.cors

ถ้าเป็นจริง อนุญาตให้ CORS ร้องขอฟังก์ชันนี้ หากนี่คือ string หรือ RegExp อนุญาตคำขอจากโดเมนที่ตรงกับค่าที่ให้ไว้ หากนี่คือ Array อนุญาตคำขอจากโดเมนที่ตรงกับรายการอาร์เรย์อย่างน้อยหนึ่งรายการ ค่าเริ่มต้นเป็นจริงสำหรับ https.CallableFunction และเท็จอย่างอื่น

ลายเซ็น:

cors?: string | boolean | RegExp | Array<string | RegExp>;

https.HttpsOptions.cpu

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

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

ลายเซ็น:

cpu?: number | "gcf_gen1";

https.HttpsOptions.ingressSettings

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

ลายเซ็น:

ingressSettings?: options.IngressSetting | ResetValue;

https.HttpsOptions.inviver

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

ลายเซ็น:

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

https.HttpsOptions.labels

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

ลายเซ็น:

labels?: Record<string, string>;

https.HttpsOptions.maxInstances

จำนวนอินสแตนซ์สูงสุดที่จะทำงานแบบขนาน

ลายเซ็น:

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

https.HttpsOptions.memory

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

ลายเซ็น:

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

https.HttpsOptions.minInstances

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

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

ลายเซ็น:

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

https.HttpsOptions.ละเว้น

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

ลายเซ็น:

omit?: boolean | Expression<boolean>;

https.HttpsOptions.region

ฟังก์ชัน HTTP สามารถแทนที่ตัวเลือกส่วนกลางและสามารถระบุหลายภูมิภาคเพื่อปรับใช้ได้

ลายเซ็น:

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

https.HttpsOptions.secrets

ลายเซ็น:

secrets?: (string | SecretParam)[];

https.HttpsOptions.serviceAccount

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

ลายเซ็น:

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

https.HttpsOptions.timeoutSeconds

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

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

ลายเซ็น:

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

https.HttpsOptions.vpcConnector

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

ลายเซ็น:

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

https.HttpsOptions.vpcConnectorEgressSettings

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

ลายเซ็น:

vpcConnectorEgressSettings?: options.VpcEgressSetting | ResetValue;