إمضاء:
export declare class FunctionBuilder
البنائين
البناء | الصفات التعريفية | وصف |
---|---|---|
(منشئ) (خيارات) | إنشاء مثيل جديد لفئة FunctionBuilder |
ملكيات
ملكية | الصفات التعريفية | يكتب | وصف |
---|---|---|---|
تحليلات | { الحدث: (analyticsEventType: سلسلة) => analytics.AnalyticsEventBuilder ; } | ||
مصادقة | { المستخدم: (userOptions?: auth.UserOptions ) => auth.UserBuilder ; } | ||
قاعدة البيانات | { المثيل: (المثيل: سلسلة) => قاعدة البيانات.InstanceBuilder ; المرجع: <المرجع يمتد السلسلة>(المسار: المرجع) => قاعدة البيانات.RefBuilder <المرجع>؛ } | ||
firestore | { المستند: <المسار يمتد السلسلة>(المسار: المسار) => firestore.DocumentBuilder <مسار>؛ مساحة الاسم: (مساحة الاسم: سلسلة) => firestore.NamespaceBuilder ; قاعدة البيانات: (قاعدة البيانات: سلسلة) => firestore.DatabaseBuilder ; } | ||
https | { onRequest: (المعالج: (req: https.Request، resp: Express.Response) => void | Promise<void>) => import("./cloud-functions"). وظيفة هتبس ; onCall: (المعالج: (البيانات: أي، السياق: https.CallableContext ) => أي | وعد<any>) => import("./cloud-functions"). HttpsFunction & import("./cloud-functions"). قابل للتشغيل <أي>؛ } | ||
com.pubsub | { الموضوع: (الموضوع: سلسلة) => pubsub.TopicBuilder ; الجدول الزمني: (الجدول: سلسلة) => pubsub.ScheduleBuilder ; } | ||
RemoteConfig | { onUpdate: (المعالج: (الإصدار: RemoteConfig.TemplateVersion السياق: EventContext ) => PromiseLike<any> | أي) => استيراد("./وظائف السحابة"). وظيفة السحابة < remoteConfig.TemplateVersion >؛ } | ||
تخزين | { دلو: (دلو؟: سلسلة) => تخزين.BucketBuilder ; الكائن: () => تخزين.ObjectBuilder ; } | ||
مهام | { TaskQueue: (options?: Tasks.TaskQueueOptions ) => المهام.TaskQueueBuilder ; } | ||
testLab | { testMatrix: () => testLab.TestMatrixBuilder ; } |
طُرق
طريقة | الصفات التعريفية | وصف |
---|---|---|
المنطقة (المناطق) | قم بتكوين المناطق التي يتم نشر الوظيفة فيها. | |
تشغيل مع (خيارات وقت التشغيل) | تكوين خيارات وقت التشغيل للوظيفة. |
منشئ الوظيفة (المنشئ)
إنشاء مثيل جديد لفئة FunctionBuilder
إمضاء:
constructor(options: DeploymentOptions);
حدود
معامل | يكتب | وصف |
---|---|---|
خيارات | خيارات النشر |
FunctionBuilder.analytics
إمضاء:
get analytics(): {
event: (analyticsEventType: string) => analytics.AnalyticsEventBuilder;
};
FunctionBuilder.auth
إمضاء:
get auth(): {
user: (userOptions?: auth.UserOptions) => auth.UserBuilder;
};
FunctionBuilder.database
إمضاء:
get database(): {
instance: (instance: string) => database.InstanceBuilder;
ref: <Ref extends string>(path: Ref) => database.RefBuilder<Ref>;
};
FunctionBuilder.firestore
إمضاء:
get firestore(): {
document: <Path extends string>(path: Path) => firestore.DocumentBuilder<Path>;
namespace: (namespace: string) => firestore.NamespaceBuilder;
database: (database: string) => firestore.DatabaseBuilder;
};
FunctionBuilder.https
إمضاء:
get https(): {
onRequest: (handler: (req: https.Request, resp: express.Response) => void | Promise<void>) => import("./cloud-functions").HttpsFunction;
onCall: (handler: (data: any, context: https.CallableContext) => any | Promise<any>) => import("./cloud-functions").HttpsFunction & import("./cloud-functions").Runnable<any>;
};
FunctionBuilder.pubsub
إمضاء:
get pubsub(): {
topic: (topic: string) => pubsub.TopicBuilder;
schedule: (schedule: string) => pubsub.ScheduleBuilder;
};
FunctionBuilder.remoteConfig
إمضاء:
get remoteConfig(): {
onUpdate: (handler: (version: remoteConfig.TemplateVersion, context: EventContext) => PromiseLike<any> | any) => import("./cloud-functions").CloudFunction<remoteConfig.TemplateVersion>;
};
FunctionBuilder.storage
إمضاء:
get storage(): {
bucket: (bucket?: string) => storage.BucketBuilder;
object: () => storage.ObjectBuilder;
};
FunctionBuilder.tasks
إمضاء:
get tasks(): {
taskQueue: (options?: tasks.TaskQueueOptions) => tasks.TaskQueueBuilder;
};
FunctionBuilder.testLab
إمضاء:
get testLab(): {
testMatrix: () => testLab.TestMatrixBuilder;
};
FunctionBuilder.region()
قم بتكوين المناطق التي يتم نشر الوظيفة فيها.
إمضاء:
region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;
حدود
معامل | يكتب | وصف |
---|---|---|
المناطق | المصفوفة<(نوع SUPPORTED_REGIONS )[الرقم] | سلسلة | تعبير <سلسلة> | إعادة تعيين القيمة> | سلسلة منطقة واحدة أو أكثر. |
عائدات:
مثال 1
وظائف. المنطقة ('us-east1')
مثال 2
وظائف. المنطقة ('us-east1'، 'us-central1')
FunctionBuilder.runWith()
تكوين خيارات وقت التشغيل للوظيفة.
إمضاء:
runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;
حدود
معامل | يكتب | وصف |
---|---|---|
runtimeOptions | خيارات وقت التشغيل | كائن يحتوي على حقول اختيارية: 1. memory : مقدار الذاكرة التي سيتم تخصيصها للوظيفة، والقيم المحتملة هي: "128 ميجابايت"، و"256 ميجابايت"، و"512 ميجابايت"، و"1 جيجابايت"، و"2 جيجابايت"، و"4 جيجابايت"، و"8 جيجابايت" . 2. timeoutSeconds : مهلة الوظيفة بالثواني، القيم المحتملة هي من 0 إلى 540. 3. سياسة failurePolicy : سياسة فشل الوظيفة، مع كون القيمة المنطقية true مكافئة لتوفير كائن إعادة محاولة فارغ. 4. vpcConnector : معرف موصل VPC في نفس المشروع والمنطقة 5. vpcConnectorEgressSettings : عند تعيين vpcConnector ، يمكنك التحكم في حركة مرور الخروج التي يتم إرسالها عبر vpcConnector . يجب ألا تكون القيمة فارغة. |
عائدات: