FunctionBuilder class

Chữ ký:

export declare class FunctionBuilder

Công ty sản xuất

Công ty sản xuất Công cụ sửa đổi Mô tả
(hàm khởi tạo)(options) Tạo một thực thể mới của lớp FunctionBuilder

Thuộc tính

Tài sản Công cụ sửa đổi Loại Mô tả
số liệu phân tích { event: (analyticsEventType: string) => analytics.AnalyticsEventBuilder; }
xác thực { user: (userOptions?: auth.UserOptions) => auth.UserBuilder; }
cơ sở dữ liệu {instance: (instance: string) => database.InstanceBuilder; ref: <ref kéo dài chuỗi>(path: Ref) => database.RefBuilder<Ref>; }
cửa hàng lửa { tài liệu: <Đường dẫn mở rộng chuỗi>(đường dẫn: Đường dẫn) => firestore.DocumentBuilder<Đường dẫn>; không gian tên: (không gian tên: chuỗi) => firestore.NamespaceBuilder; cơ sở dữ liệu: (cơ sở dữ liệu: chuỗi) => firestore.DatabaseBuilder; }
https { onRequest: (handler: (req: https.Request, resp: express.Response) => void | Promise<void>) => import("./cloud-functions").HttpsFunction; onCall: (handler: (data: any, ngữ cảnh: https.CallableContext) => any | Promise<any>) => import("./cloud-functions").HttpsFunction & import("./cloud-functions").Có thể chạy<any>; }
pubsub { topic: (topic: string) => pubsub.TopicsBuilder; lịch biểu: (lịch biểu: chuỗi) => pubsub.ScheduleBuilder; }
remoteConfig { onUpdate: (handler: (version: remoteConfig.TemplateVersion, ngữ cảnh: EventContext) => PromiseLike<any> | any) => import("./cloud-functions").CloudFunction<remoteConfig.TemplateVersion>; }
bộ nhớ { nhóm: (bộ chứa?: chuỗi) => storage.BucketBuilder; đối tượng: () => storage.ObjectBuilder; }
việc cần làm { taskQueue: (options?: tasks.TaskQueueOptions) => tasks.TaskQueueBuilder; }
testLab { testMatrix: () => testLab.TestMatrixBuilder; }

Phương thức

Phương thức Công cụ sửa đổi Mô tả
region(khu vực) Định cấu hình những khu vực triển khai hàm.
runWith(runtimeOptions) Định cấu hình các tuỳ chọn thời gian chạy cho hàm.

FunctionBuilder.(hàm khởi tạo)

Tạo một thực thể mới của lớp FunctionBuilder

Chữ ký:

constructor(options: DeploymentOptions);

Thông số

Thông số Loại Mô tả
tuỳ chọn DeploymentOptions (Tuỳ chọn triển khai)

FunctionBuilder.analytics

Chữ ký:

get analytics(): {
        event: (analyticsEventType: string) => analytics.AnalyticsEventBuilder;
    };

FunctionBuilder.auth

Chữ ký:

get auth(): {
        user: (userOptions?: auth.UserOptions) => auth.UserBuilder;
    };

FunctionBuilder.database

Chữ ký:

get database(): {
        instance: (instance: string) => database.InstanceBuilder;
        ref: <Ref extends string>(path: Ref) => database.RefBuilder<Ref>;
    };

FunctionBuilder.firestore

Chữ ký:

get firestore(): {
        document: <Path extends string>(path: Path) => firestore.DocumentBuilder<Path>;
        namespace: (namespace: string) => firestore.NamespaceBuilder;
        database: (database: string) => firestore.DatabaseBuilder;
    };

FunctionBuilder.https

Chữ ký:

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

Chữ ký:

get pubsub(): {
        topic: (topic: string) => pubsub.TopicBuilder;
        schedule: (schedule: string) => pubsub.ScheduleBuilder;
    };

FunctionBuilder.remoteConfig

Chữ ký:

get remoteConfig(): {
        onUpdate: (handler: (version: remoteConfig.TemplateVersion, context: EventContext) => PromiseLike<any> | any) => import("./cloud-functions").CloudFunction<remoteConfig.TemplateVersion>;
    };

FunctionBuilder.storage

Chữ ký:

get storage(): {
        bucket: (bucket?: string) => storage.BucketBuilder;
        object: () => storage.ObjectBuilder;
    };

FunctionBuilder.tasks

Chữ ký:

get tasks(): {
        taskQueue: (options?: tasks.TaskQueueOptions) => tasks.TaskQueueBuilder;
    };

FunctionBuilder.testLab

Chữ ký:

get testLab(): {
        testMatrix: () => testLab.TestMatrixBuilder;
    };

FunctionBuilder.region()

Định cấu hình những khu vực triển khai hàm.

Chữ ký:

region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;

Thông số

Thông số Loại Mô tả
vùng Mảng<(loại của supported_REGIONS)[number] | chuỗi | Biểu thức<string> | Đặt lại giá trị> Một hoặc nhiều chuỗi khu vực.

Trường hợp trả lại hàng:

FunctionBuilder

Ví dụ 1

function.region('us-east1')

Ví dụ 2

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

FunctionBuilder.runWith()

Định cấu hình các tuỳ chọn thời gian chạy cho hàm.

Chữ ký:

runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

Thông số

Thông số Loại Mô tả
RuntimeOptions RuntimeOptions (Tuỳ chọn thời gian chạy) Đối tượng có các trường không bắt buộc: 1. memory: dung lượng bộ nhớ cần phân bổ cho hàm, có thể sử dụng các giá trị sau: "128MB", "256MB", "512MB", "1GB", "2GB", "4GB" và "8GB". 2. timeoutSeconds: thời gian chờ cho hàm tính bằng giây, các giá trị có thể có là từ 0 đến 540. 3. failurePolicy: chính sách lỗi của hàm, với boolean true tương đương với việc cung cấp một đối tượng thử lại trống. 4. vpcConnector: mã của trình kết nối VPC trong cùng một dự án và khu vực 5. vpcConnectorEgressSettings: khi bạn đặt vpcConnector, kiểm soát lưu lượng ra được gửi thông qua vpcConnector.Giá trị không được là giá trị rỗng.

Trường hợp trả lại hàng:

FunctionBuilder