الدوال
| دالة | الوصف |
|---|---|
| config() | تخزين بيانات إعداد المشروع واستردادها مثل مفاتيح واجهة برمجة التطبيقات التابعة لجهة خارجية أو الإعدادات الأخرى ويمكنك ضبط قيم الإعداد باستخدام واجهة سطر الأوامر في Firebase كما هو موضَّح في [إعداد البيئة](/docs/functions/config-env). |
| optionsToEndpoint(options) | |
| optionsToTrigger(options) | |
| region(المناطق) | اضبط المناطق التي يتم تفعيل الدالة فيها. |
| runWith(runtimeOptions) | يمكنك ضبط خيارات بيئة التشغيل للدالة. |
صفوف
| الفئة | الوصف |
|---|---|
| تغيير | واجهة Cloud Functions التي تعرض الأحداث التي تتغيّر حالتها، مثل Realtime Database أو حدث Cloud Firestore onWrite وonUpdate.لمزيد من المعلومات عن التنسيق المستخدَم لإنشاء عناصر Change، يُرجى الاطّلاع على المعلومات أدناه. |
| أداة إنشاء الدوال |
واجهات
| الواجهة | الوصف |
|---|---|
| BlockFunction | نوع الدالة لمشغِّلات حظر المصادقة. |
| CloudFunction | نوع الدالة لجميع المشغلات التي لا تستخدم HTTPS. ويجب تصدير هذه البيانات من ملف JavaScript لتحديد دالة Cloud.هذا النوع هو دالة JavaScript خاصة تتعامل مع كائن Event وفقًا لنموذج كوسيطة الوحيدة. |
| DeploymentOptions | خيارات الضبط لدالة تنطبق أثناء نشر الدالة. |
| الحدث | تنسيق التحويل الإلكتروني لحدث معيّن |
| EventContext | السياق الذي وقع فيه الحدث. |
| سياسة الإخفاق | خيار ضبط لسياسة التعذُّر في وظائف الخلفية |
| دالة HttpsFunction | نوع الدالة لمشغّلات HTTPS. ويجب تصدير هذه البيانات من ملف JavaScript لتحديد "دالة السحابة الإلكترونية". |
| المورد | المورد هو تنسيق قياسي لتحديد مورد (google.rpc.context.AttributeContext.Resource). في Cloud Functions، يكون المورد الذي أدّى إلى تشغيل الدالة، مثل حزمة تخزين. |
| قابل للتشغيل | تتضمن الدالة Runnable طريقة run التي تستدعي مباشرةً الدالة التي يحددها المستخدم، وهي مفيدة لاختبار الوحدة. |
| خيارات وقت التشغيل | خيارات الضبط لدالة تنطبق في وقت التشغيل. |
| الجدول الزمني | خيارات الضبط للدوال المُجدوَلة |
| الجدول الزمني لإعادة المحاولة | خيارات إعادة المحاولة من خلال أداة الجدولة لا ينطبق هذا الإعداد إلا على الدوال المُجدوَلة. |
مساحات الاسم
| مساحة الاسم | الوصف |
|---|---|
| إحصاءات Google | |
| المصادقة | |
| قاعدة بيانات | |
| مخزن إطفاء | |
| https | |
| أداة التسجيل | |
| المَعلمات | |
| pubsub | |
| remoteConfig | |
| مساحة التخزين | |
| المهام | |
| testLab |
المتغيرات
| متغير | الوصف |
|---|---|
| التطبيق | |
| DEFAULT_FAILURE_POLICY | |
| INGRESS_SETTINGS_OPTIONS | قائمة الخيارات المتاحة لـ IngressSettings |
| MAX_NUMBER_USER_LABELS | |
| MAX_وقت_SECONDS | الحد الأقصى لقيمة مهلة دوال السحابة. |
| MIN_تذكير_SECONDS | الحد الأدنى لقيمة مهلة دوال السحابة. |
| RESET_VALUE | قيمة إعداد خاصة لإعادة ضبط الإعدادات على الإعدادات التلقائية للنظام الأساسي. |
| SUPPORTED_AREAS | قائمة بجميع المناطق التي تتوفّر فيها دوال Cloud |
| صالح_MEMORY_OPTIONS | قائمة بخيارات الذاكرة المتاحة التي توفّرها Cloud Functions |
| VPC_EGRESS_SETTINGS_OPTIONS | قائمة الخيارات المتاحة لـ VpcConnectorEgressSettings |
()config
تخزين بيانات إعداد المشروع واستردادها مثل مفاتيح واجهة برمجة التطبيقات التابعة لجهة خارجية أو الإعدادات الأخرى ويمكنك ضبط قيم الإعداد باستخدام واجهة سطر الأوامر في Firebase كما هو موضّح في [إعداد البيئة](/docs/functions/config-env).
Signature:
export declare function config(): Record<string, any>;
المرتجعات:
سجل<string, any>
OptionToEndpoint()
Signature:
export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;
المَعلمات
| المعلمة | النوع | الوصف |
|---|---|---|
| خيارات | DeploymentOptions |
المرتجعات:
نقطة نهاية البيان
OptionToTrigger()
Signature:
export declare function optionsToTrigger(options: DeploymentOptions): any;
المَعلمات
| المعلمة | النوع | الوصف |
|---|---|---|
| خيارات | DeploymentOptions |
المرتجعات:
أي
المنطقة()
اضبط المناطق التي يتم نشر الدالة فيها.
Signature:
export declare function region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;
المَعلمات
| المعلمة | النوع | الوصف |
|---|---|---|
| المناطق | المصفوفة<(typeof SUPPORTED_GRANTS)[number] | سلسلة | التعبير<string> | إعادة ضبط القيمة> | سلسلة أو أكثر من سلاسل المنطقة |
المرتجعات:
مثال 1
function.region('us-east1')
مثال 2
function.region('us-east1', 'us-central1')
runWith()
يمكنك ضبط خيارات بيئة التشغيل للدالة.
Signature:
export declare function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;
المَعلمات
| المعلمة | النوع | الوصف |
|---|---|---|
| خيارات وقت التشغيل | خيارات وقت التشغيل | كائن ذو حقول اختيارية: 1. memory: مقدار الذاكرة التي سيتم تخصيصها للدالة، والقيم المحتملة هي: "128 ميغابايت" و"256 ميغابايت" و"512 ميغابايت" و"1 غيغابايت" و"2 غيغابايت" و"4 غيغابايت" و"8 غيغابايت". 2- timeoutSeconds: مهلة الدالة بالثواني، تتراوح القيم المحتملة بين 0 و540. 3- failurePolicy: سياسة الإخفاق للدالة، حيث تكون القيمة المنطقية true مكافئة لتوفير كائن إعادة محاولة فارغ. 4. vpcConnector: معرّف موصل VPC في المشروع والمنطقة نفسيهما 5- vpcConnectorEgressSettings: عند ضبط vpcConnector، يمكنك التحكّم في زيارات الخروج التي يتم إرسالها من خلال vpcConnector. 6- serviceAccount: حساب خدمة محدَّد للدالة. 7- ingressSettings: إعدادات الدخول للدالة التي تتحكّم في المكان الذي يمكن استدعاء دالة HTTPS منه.يجب ألا تكون القيمة فارغة. |
المرتجعات:
التطبيق
Signature:
app: {
setEmulatedAdminApp: typeof setEmulatedAdminApp;
}
DEFAULT_FAILURE_POLICY
Signature:
DEFAULT_FAILURE_POLICY: FailurePolicy
INGRESS_SETTINGS_OPTIONS
قائمة الخيارات المتاحة لـ IngressSettings
Signature:
INGRESS_SETTINGS_OPTIONS: readonly ["INGRESS_SETTINGS_UNSPECIFIED", "ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]
MAX_NUMBER_USER_LABELS
Signature:
MAX_NUMBER_USER_LABELS = 58
الحد الأقصى للمدة: MAX_duration_SECONDS
الحد الأقصى لقيمة مهلة دوال السحابة.
Signature:
MAX_TIMEOUT_SECONDS = 540
MIN_وقت_SECONDS
الحد الأدنى لقيمة مهلة دوال السحابة.
Signature:
MIN_TIMEOUT_SECONDS = 0
إعادة الضبط
قيمة إعداد خاصة لإعادة ضبط الإعدادات على الإعدادات التلقائية للنظام الأساسي.
Signature:
RESET_VALUE: ResetValue
SUPPORTED_AREAS
قائمة بجميع المناطق التي تتوفّر فيها دوال Cloud
Signature:
SUPPORTED_REGIONS: readonly ["us-central1", "us-east1", "us-east4", "us-west2", "us-west3", "us-west4", "europe-central2", "europe-west1", "europe-west2", "europe-west3", "europe-west6", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-southeast1", "asia-southeast2", "northamerica-northeast1", "southamerica-east1", "australia-southeast1"]
خيار صالح_MEMORY_OPTIONS
قائمة بخيارات الذاكرة المتاحة التي توفّرها Cloud Functions
Signature:
VALID_MEMORY_OPTIONS: readonly ["128MB", "256MB", "512MB", "1GB", "2GB", "4GB", "8GB"]
VPC_EGRESS_SETTINGS_OPTIONS
قائمة الخيارات المتاحة لـ VpcConnectorEgressSettings
Signature:
VPC_EGRESS_SETTINGS_OPTIONS: readonly ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]