GlobalOptions interface

GlobalOptions הן אפשרויות שניתן להגדיר על פני פרויקט שלם. אפשרויות אלה משותפות לפונקציות HTTPS וטיפול באירועים.

חֲתִימָה:

export interface GlobalOptions 

נכסים

תכונה סוּג תיאור
במקביל מספר | ביטוי <מספר> | ResetValue מספר הבקשות שפונקציה יכולה לשרת בו-זמנית.
מעבד מספר | "gcf_gen1" מספר חלקי של מעבדים להקצאה לפונקציה.
לאכוף את AppCheck בוליאני קובע אם Firebase App Check נאכף. ברירת המחדל ל-false.
ingressSettings IngressSetting | ResetValue הגדרות כניסה השולטות מאיפה ניתן לקרוא לפונקציה זו.
מפעיל "ציבורי" | "פרטי" | מחרוזת | חוּט[] Invoker להגדיר בקרת גישה בפונקציות HTTPS.
תוויות הקלט<string, string> תוויות משתמש להגדרה בפונקציה.
maxInstances מספר | ביטוי <מספר> | ResetValue מספר מקסימלי של מופעים שיכולים לפעול במקביל.
זיכרון MemoryOption | ביטוי <מספר> | ResetValue כמות הזיכרון להקצאה לפונקציה.
minInstances מספר | ביטוי <מספר> | ResetValue מספר מינימלי של מופעים בפועל שיפעלו בזמן נתון.
לְהַשְׁמִיט בוליאני | ביטוי <בוליאנית> אם נכון, אין לפרוס או לחקות פונקציה זו.
לשמורExternalChanges בוליאני שולט אם תצורת הפונקציה ששונתה מחוץ למקור הפונקציה תישמר. ברירת המחדל ל-false.
אזור נתמך אזור | מחרוזת | ביטוי <string> | ResetValue אזור שבו יש לפרוס פונקציות.
סודות (מחרוזת | SecretParam)[]
חשבון שירות מחרוזת | ביטוי <string> | ResetValue חשבון שירות ספציפי עבור הפונקציה שבה תפעל.
פסק זמן שניות מספר | ביטוי <מספר> | ResetValue פסק זמן לפונקציה בשניות, ערכים אפשריים הם 0 עד 540. פונקציות HTTPS יכולות לציין פסק זמן גבוה יותר.
vpcConnector מחרוזת | ביטוי <string> | ResetValue חבר פונקציה למחבר VPC שצוין.
vpcConnectorEgressSettings VpcEgressSetting | ResetValue הגדרות יציאה למחבר VPC.

GlobalOptions.Concurrency

מספר הבקשות שפונקציה יכולה לשרת בו-זמנית.

ניתן להחיל רק על פונקציות הפועלות ב-Cloud Functions (דור שני)). ערך null משחזר את ברירת המחדל של ברירת המחדל (80 כאשר CPU > = 1, 1 אחרת). לא ניתן להגדיר את המקבילות לערך אחר מלבד 1 אם cpu קטן מ-1. הערך המקסימלי עבור במקביל הוא 1,000.

חֲתִימָה:

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

GlobalOptions.cpu

מספר חלקי של מעבדים להקצאה לפונקציה.

ברירת המחדל היא 1 עבור פונקציות עם < = 2GB RAM וגדל עבור גדלי זיכרון גדולים יותר. זה שונה מברירות המחדל בעת שימוש בכלי השירות gcloud ושונה מהסכום הקבוע שהוקצה ב-Cloud Functions (דור ראשון). כדי לחזור לכמויות ה-CPU בשימוש ב-gcloud או ב-Cloud Functions (דור ראשון), הגדר את זה לערך "gcf_gen1"

חֲתִימָה:

cpu?: number | "gcf_gen1";

GlobalOptions.enforceAppCheck

קובע אם Firebase App Check נאכף. ברירת המחדל ל-false.

כאשר זה נכון, בקשות עם אסימונים לא חוקיים מגיבות אוטומטית עם שגיאת 401 (לא מורשית). כאשר שווא, בקשות עם אסימונים לא חוקיים מגדירים את event.app כבלתי undefined .

חֲתִימָה:

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

מספר מינימלי של מופעים בפועל שיפעלו בזמן נתון.

מופעים מחויבים עבור הקצאת זיכרון ו-10% מהקצאת ה-CPU כשהם לא פעילים.

חֲתִימָה:

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

GlobalOptions.omit

אם נכון, אין לפרוס או לחקות פונקציה זו.

חֲתִימָה:

omit?: boolean | Expression<boolean>;

GlobalOptions.preserveExternalChanges

שולט אם תצורת הפונקציה ששונתה מחוץ למקור הפונקציה תישמר. ברירת המחדל ל-false.

כאשר מגדירים תצורה זמינה בפלטפורמה בסיסית שעדיין אינה זמינה ב-Firebase SDK for 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,800 שניות (30 דקות).

חֲתִימָה:

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

GlobalOptions.vpcConnector

חבר פונקציה למחבר VPC שצוין.

חֲתִימָה:

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

GlobalOptions.vpcConnectorEgressSettings

הגדרות יציאה למחבר VPC.

חֲתִימָה:

vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;