FunctionBuilder class

חֲתִימָה:

export declare class FunctionBuilder 

בונים

בַּנַאִי	משנה	תיאור
(קונסטרוקטור) (אפשרויות)		בונה מופע חדש של המחלקה FunctionBuilder

נכסים

תכונה	משנה	סוּג	תיאור
ניתוח		{ event: (analyticsEventType: string) => analytics.AnalyticsEventBuilder ; }
אישור		{ user: (userOptions?: auth.UserOptions ) => auth.UserBuilder ; }
מאגר מידע		{ instance: (instance: string) => database.InstanceBuilder ; ref: <Ref extends string>(נתיב: Ref) => database.RefBuilder <Ref>; }
firestore		{ document: <Path extends string>(path: Path) => firestore.DocumentBuilder <נתיב>; מרחב שמות: (מרחב שם: מחרוזת) => firestore.NamespaceBuilder ; מסד נתונים: (מסד נתונים: מחרוזת) => firestore.DatabaseBuilder ; }
https		{ onRequest: (handler: (req: https.Request, resp: express.Response) => void | Promise<void>) => import("./cloud-functions"). HttpsFunction ; onCall: (מטפל: (נתונים: כל, הקשר: https.CallableContext ) => כל | Promise<any>) => import("./cloud-functions"). HttpsFunction & import("./cloud-functions"). ניתן להרצה <כל>; }
pubsub		{ topic: (topic: string) => pubsub.TopicBuilder ; לוח זמנים: (לוח זמנים: string) => pubsub.ScheduleBuilder ; }
remoteconfig		{ onUpdate: (מטפל: (גרסה: remoteConfig.TemplateVersion , הקשר: EventContext ) => הבטח כמו<any> | any) => import("./cloud-functions"). CloudFunction < remoteConfig.TemplateVersion >; }
אִחסוּן		{ bucket: (bucket?: string) => storage.BucketBuilder ; אובייקט: () => אחסון.ObjectBuilder ; }
משימות		{ taskQueue: (אפשרויות?: tasks.TaskQueueOptions ) => משימות.TaskQueueBuilder ; }
testLab		{ testMatrix: () => testLab.TestMatrixBuilder ; }

שיטות

שיטה	משנה	תיאור
אזור (אזורים)		הגדר את האזורים אליהם נפרסת הפונקציה.
runWith(runtimeOptions)		הגדר אפשרויות זמן ריצה עבור הפונקציה.

FunctionBuilder.(קונסטרוקטור)

בונה מופע חדש של המחלקה 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 )[מספר] | מחרוזת | ביטוי <string> | 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 : הזמן הקצוב לפונקציה בשניות, הערכים האפשריים הם 0 עד 540. 3. failurePolicy : מדיניות הכשל של הפונקציה, כאשר true בוליאני שווה ערך לספק אובייקט ניסיון חוזר ריק. 4. vpcConnector : מזהה של מחבר VPC באותו פרויקט ובאותו אזור 5. vpcConnectorEgressSettings : כאשר מוגדר vpcConnector , קבע איזו תעבורת יציאה תישלח דרך vpcConnector . הערך לא יכול להיות ריק.

החזרות:

FunctionBuilder