FunctionBuilder class

امضا:

export declare class FunctionBuilder 

سازندگان

سازنده	اصلاح کننده ها	شرح
(سازنده) (گزینه ها)		یک نمونه جدید از کلاس FunctionBuilder می سازد

خواص

ویژگی	اصلاح کننده ها	تایپ کنید	شرح
تجزیه و تحلیل		{ رویداد: (analyticsEventType: string) => analytics.AnalyticsEventBuilder ; }
اعتبار		{ کاربر: (userOptions؟: auth.UserOptions ) => auth.UserBuilder ; }
پایگاه داده		{ instance: (instance: string) => database.InstanceBuilder ; ref: <Ref extends string>(path: Ref) => database.RefBuilder <Ref>; }
آتش نشانی		{ document: <Path extends string>(path: Path) => firestore.DocumentBuilder <مسیر>؛ namespace: (namespace: string) => firestore.NamespaceBuilder ; پایگاه داده: (پایگاه داده: رشته) => firestore.DatabaseBuilder ; }
https		{ onRequest: (handler: (req: https.Request, resp: express.Response) => void | Promise<void>) => import("./cloud-functions"). HttpsFunction ; onCall: (handler: (داده: هر، زمینه: https.CallableContext ) => هر | Promise<any>) => import("./cloud-functions"). HttpsFunction & import("./cloud-functions"). قابل اجرا <هر> }
ساب میخانه		{ موضوع: (موضوع: رشته) => pubsub.TopicBuilder ; برنامه زمانبندی: (زمانبندی: رشته) => pubsub.ScheduleBuilder ; }
remoteConfig		{ onUpdate: (handler: (نسخه: remoteConfig.TemplateVersion ، زمینه: EventContext ) => PromiseLike<هر> | any) => import("./cloud-functions"). CloudFunction < remoteConfig.TemplateVersion > }
ذخیره سازی		{ bucket: (bucket?: string) => storage.BucketBuilder ; شی: () => storage.ObjectBuilder ; }
وظایف		{ taskQueue: (گزینه ها؟: tasks.TaskQueueOptions ) => tasks.TaskQueueBuilder ; }
تست آزمایشگاه		{ testMatrix: () => testLab.TestMatrixBuilder ; }

مواد و روش ها

روش	اصلاح کننده ها	شرح
منطقه (مناطق)		مناطقی را که تابع در آنها مستقر شده است پیکربندی کنید.
runWith(runtimeOptions)		گزینه های زمان اجرا را برای تابع پیکربندی کنید.

FunctionBuilder.(سازنده)

یک نمونه جدید از کلاس FunctionBuilder می سازد

امضا:

constructor(options: DeploymentOptions);

مولفه های

پارامتر	تایپ کنید	شرح
گزینه ها	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 )[شماره] | رشته | اصطلاح <رشته> | ResetValue>	یک یا چند رشته منطقه.

برمی گرداند:

FunctionBuilder

مثال 1

functions.region('us-east1')

مثال 2

functions.region('us-east1', 'us-central1')

FunctionBuilder.runWith()

گزینه های زمان اجرا را برای تابع پیکربندی کنید.

امضا:

runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

مولفه های

پارامتر	تایپ کنید	شرح
runtimeOptions	RuntimeOptions	شی با فیلدهای اختیاری: 1. memory : مقدار حافظه برای تخصیص به تابع، مقادیر ممکن عبارتند از: '128MB'، '256MB'، '512MB'، '1GB'، '2GB'، '4GB'، و '8GB' . 2. timeoutSeconds : مهلت زمانی برای تابع در ثانیه، true ممکن از 0 failurePolicy 540 است. 4. vpcConnector vpcConnector شناسه یک رابط vpcConnector vpcConnectorEgressSettings همان پروژه و منطقه. مقدار نباید صفر باشد.

برمی گرداند:

FunctionBuilder