FunctionBuilder class

ลายเซ็น:

export declare class FunctionBuilder 

ผู้ผลิต

ผู้ผลิต	คีย์ตัวปรับแต่ง	คำอธิบาย
(เครื่องมือสร้าง)(ตัวเลือก)		สร้างอินสแตนซ์ใหม่ของคลาส FunctionBuilder

พร็อพเพอร์ตี้

พร็อพเพอร์ตี้	คีย์ตัวปรับแต่ง	ประเภท	คำอธิบาย
Analytics		{ event: (analyticsEventType: string) => analytics.AnalyticsEventBuilder; }
การตรวจสอบสิทธิ์		{ user: (userOptions?: auth.UserOptions) => auth.UserBuilder; }
ฐานข้อมูล		{ อินสแตนซ์: (อินสแตนซ์: สตริง) => database.InstanceBuilder; ref: <RefExtends string>(path: Ref) => database.RefBuilder<Ref>; }
Firestore		{ เอกสาร: <เส้นทางขยายสตริง>(เส้นทาง: เส้นทาง) => firestore.DocumentBuilder<Path>; Namespace: (Namespace: string) => firestore.NamespaceBuilder; ฐานข้อมูล: (ฐานข้อมูล: สตริง) => firestore.DatabaseBuilder; }
https		{ onRequest: (แฮนเดิล: (req: https.Request, resp: express.Response) => void | Promise<void>) => Import("./cloud-functions")HttpsFunction; onCall: (แฮนเดิล: (ข้อมูล: any, บริบท: https.CallableContext) => any | Promise<any>) => Import("./cloud-functions")HttpsFunction และ Import("./cloud-functions")เรียกใช้ได้<any>; }
PubSub		{ หัวข้อ: (หัวข้อ: สตริง) => pubsub.TopicBuilder; กำหนดการ: (กำหนดเวลา: สตริง) => pubsub.ScheduleBuilder; }
remoteConfig		{ onUpdate: (handler: (version: remoteConfig.TemplateVersion, Context: EventContext) => PromiseLike<any> | any) => Import("./cloud-functions")CloudFunction<remoteConfig.TemplateVersion>; }
พื้นที่เก็บข้อมูล		{ ที่เก็บข้อมูล: (bucket?: สตริง) => storage.BucketBuilder; ออบเจ็กต์: () => storage.ObjectBuilder; }
งาน		{ TasksQueue: (ตัวเลือก?: tasks.TaskQueueOptions) => tasks.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)[number] | สตริง | นิพจน์<string> | รีเซ็ตค่า>	สตริงภูมิภาคอย่างน้อย 1 รายการ

การคืนสินค้า:

FunctionBuilder

ตัวอย่างที่ 1

Functions.region('us-east1')

ตัวอย่างที่ 2

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

FunctionBuilder.runWith()

กำหนดค่าตัวเลือกรันไทม์สำหรับฟังก์ชัน

ลายเซ็น:

runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ตัวเลือกรันไทม์	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