GlobalOptions interface

GlobalOptions هي خيارات يمكن تعيينها عبر مشروع بأكمله. هذه الخيارات شائعة لوظائف HTTPS ومعالجة الأحداث.

إمضاء:

export interface GlobalOptions 

ملكيات

ملكية	يكتب	وصف
التزامن	رقم | التعبير <رقم> | إعادة تعيين القيمة	عدد الطلبات التي يمكن أن تخدمها الوظيفة في وقت واحد.
وحدة المعالجة المركزية	رقم | "gcf_gen1"	عدد كسري من وحدات المعالجة المركزية (CPU) لتخصيصها لوظيفة ما.
فرض	قيمة منطقية	يحدِّد ما إذا كان Firebase AppCheck مطبقًا أم لا. افتراضات على خطأ.
دخولإعدادات	الدخول | إعادة تعيين القيمة	إعدادات الدخول التي تتحكم في المكان الذي يمكن استدعاء هذه الوظيفة منه.
المستدعي	"عام" | "خاص" | سلسلة | خيط[]	Invoker لتعيين التحكم في الوصول على وظائف https.
تسميات	سجل <سلسلة ، سلسلة>	تسميات المستخدم لضبط الوظيفة.
maxInstances	رقم | التعبير <رقم> | إعادة تعيين القيمة	أقصى عدد من المثيلات التي سيتم تشغيلها بالتوازي.
ذاكرة	MemoryOption | التعبير <رقم> | إعادة تعيين القيمة	مقدار الذاكرة المراد تخصيصها لوظيفة ما.
دقيقة	رقم | التعبير <رقم> | إعادة تعيين القيمة	الحد الأدنى لعدد المثيلات الفعلية التي سيتم تشغيلها في وقت معين.
حذف	منطقي | التعبير <منطقي>	إذا كان هذا صحيحًا ، فلا تنشر هذه الوظيفة أو تحاكيها.
saveExternalChanges	قيمة منطقية	يتحكم في ما إذا كان سيتم الاحتفاظ بتكوين الوظيفة الذي تم تعديله خارج مصدر الوظيفة. افتراضات على خطأ.
منطقة	المدعومة | خيط	المنطقة التي يجب نشر الوظائف فيها.
أسرار	(سلسلة | SecretParam) []
serviceAccount	سلسلة | إعادة تعيين القيمة	حساب خدمة محدد للدالة المراد تشغيلها كملف.
مهلة ثانية	رقم | التعبير <رقم> | إعادة تعيين القيمة	مهلة الوظيفة بالثواني ، القيم المحتملة هي من 0 إلى 540. يمكن أن تحدد وظائف HTTPS مهلة أعلى.
vpc	سلسلة | التعبير <سلسلة> | إعادة تعيين القيمة	قم بتوصيل وظيفة السحابة بموصل VPC المحدد.
vpcConnectorEgressSettings	VpcEgressSetting | إعادة تعيين القيمة	إعدادات الخروج لموصل VPC.

GlobalOptions.concurrency

عدد الطلبات التي يمكن أن تخدمها الوظيفة في وقت واحد.

لا يمكن تطبيقه إلا على الوظائف التي تعمل على Cloud Functions v2. تستعيد قيمة فارغة التزامن الافتراضي (80 عند CPU> = 1 ، 1 خلاف ذلك). لا يمكن تعيين التزامن على أي قيمة بخلاف 1 إذا كانت cpu أقل من 1. الحد الأقصى لقيمة التزامن هو 1،000.

إمضاء:

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

GlobalOptions.cpu

عدد كسري من وحدات المعالجة المركزية (CPU) لتخصيصها لوظيفة ما.

افتراضيات على 1 للوظائف ذات < = 2 جيجابايت من ذاكرة الوصول العشوائي ويزيد لأحجام الذاكرة الأكبر. هذا يختلف عن الإعدادات الافتراضية عند استخدام الأداة المساعدة gcloud ويختلف عن المبلغ الثابت المعين في Google Cloud Functions جيل 1. للعودة إلى كميات وحدة المعالجة المركزية المستخدمة في gcloud أو في Cloud Functions Gen 1 ، اضبط هذا على القيمة "gcf_gen1"

إمضاء:

cpu?: number | "gcf_gen1";

GlobalOptions.enforceAppCheck

يحدِّد ما إذا كان Firebase AppCheck مطبقًا أم لا. افتراضات على خطأ.

عندما يكون صحيحًا ، فإن الطلبات ذات الرموز المميزة غير الصالحة تستجيب تلقائيًا مع خطأ 401 (غير مصرح به). عندما تكون خاطئة ، تؤدي الطلبات ذات الرموز المميزة غير الصالحة إلى تعيين event.app إلى إلغاء التعريف.

إمضاء:

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٪ من تخصيص وحدة المعالجة المركزية أثناء الخمول.

إمضاء:

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

GlobalOptions.omit

إذا كان هذا صحيحًا ، فلا تنشر هذه الوظيفة أو تحاكيها.

إمضاء:

omit?: boolean | Expression<boolean>;

GlobalOptions.preserveExternalChanges

يتحكم في ما إذا كان سيتم الاحتفاظ بتكوين الوظيفة الذي تم تعديله خارج مصدر الوظيفة. افتراضات على خطأ.

عند إعداد التكوين المتاح في النظام الأساسي الأساسي الذي لم يتوفر بعد في Firebase Functions SDK ، نوصي بشدة بتعيين preserveExternalChanges إلى true . بخلاف ذلك ، عندما تُصدر Firebase Functions SDK إصدارًا جديدًا من SDK مع دعم التكوين المفقود ، فقد يتم محو الإعداد الذي تم تكوينه يدويًا لوظيفتك عن غير قصد.

إمضاء:

preserveExternalChanges?: boolean;

GlobalOptions.region

المنطقة التي يجب نشر الوظائف فيها.

إمضاء:

region?: SupportedRegion | string;

GlobalOptions.secrets

إمضاء:

secrets?: (string | SecretParam)[];

GlobalOptions.serviceAccount

حساب خدمة محدد للدالة المراد تشغيلها كملف.

إمضاء:

serviceAccount?: string | ResetValue;

GlobalOptions.timeoutSeconds

مهلة الوظيفة بالثواني ، القيم المحتملة هي من 0 إلى 540. يمكن أن تحدد وظائف HTTPS مهلة أعلى.

الحد الأدنى من المهلة لوظيفة من الجيل الثاني هو 1 ثانية. يعتمد أقصى مهلة لوظيفة ما على نوع الوظيفة: وظائف معالجة الأحداث لها أقصى مهلة 540 ثانية (9 دقائق). HTTPS والوظائف القابلة للاستدعاء لها مهلة قصوى تبلغ 36،00 ثانية (ساعة واحدة). وظائف قائمة انتظار المهام لها مهلة قصوى تبلغ 1800 ثانية (30 دقيقة)

إمضاء:

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

GlobalOptions.vpcConnector

قم بتوصيل وظيفة السحابة بموصل VPC المحدد.

إمضاء:

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

GlobalOptions.vpcConnectorEgressSettings

إعدادات الخروج لموصل VPC.

إمضاء:

vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;