FunctionBuilder class

Подпись:

export declare class FunctionBuilder

Конструкторы

Конструктор Модификаторы Описание
(конструктор)(опции) Создает новый экземпляр класса FunctionBuilder .

Характеристики

Свойство Модификаторы Тип Описание
аналитика { событие: (analyticsEventType: строка) => аналитика.AnalyticsEventBuilder ; }
авторизация { пользователь: (userOptions?: auth.UserOptions ) => авторизация.UserBuilder ; }
база данных { экземпляр: (экземпляр: строка) => база данных.InstanceBuilder ; ref: <Ref расширяет строку>(путь: Ref) => data.RefBuilder <Ссылка>; }
пожарная лавка { document: <Путь расширяет строку>(путь: Путь) => firestore.DocumentBuilder <Путь>; пространство имен: (пространство имен: строка) => firestore.NamespaceBuilder ; база данных: (база данных: строка) => firestore.DatabaseBuilder ; }
https { onRequest: (обработчик: (req: https.Request, соответственно: express.Response) => void | Promise<void>) => import("./cloud-functions"). HttpsФункция ; onCall: (обработчик: (данные: любой, контекст: https.CallableContext ) => любой | Promise<any>) => import("./cloud-functions"). HttpsFunction & import("./cloud-functions"). работоспособный <любой>; }
пабсаб { тема: (тема: строка) => pubsub.TopicBuilder ; расписание: (расписание: строка) => pubsub.ScheduleBuilder ; }
удаленнаяконфигурация { onUpdate: (обработчик: (версия: RemoteConfig.TemplateVersion , контекст: EventContext ) => PromiseLike<любой> | любой) => import("./cloud-functions"). Облачная функция < remoteConfig.TemplateVersion >; }
хранилище { ведро: (ведро?: строка) => хранилище.BucketBuilder ; объект: () => хранилище.ObjectBuilder ; }
задачи { TaskQueue: (варианты?: Tasks.TaskQueueOptions ) => задачи.TaskQueueBuilder ; }
тестовая лаборатория { testMatrix: () => testLab.TestMatrixBuilder ; }

Методы

Метод Модификаторы Описание
регион(регионы) Настройте регионы, в которых будет развернута функция.
runWith (параметры выполнения) Настройте параметры времени выполнения для функции.

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.хранилище

Подпись: 

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 )[число] | строка | Выражение <строка> | СбросЗначения> Одна или несколько строк региона.

Возврат:

FunctionBuilder

Пример 1

функции.регион('us-east1')

Пример 2

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

FunctionBuilder.runWith()

Настройте параметры времени выполнения для функции.

Подпись: 

runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

Параметры

Параметр Тип Описание
Параметры времени выполнения Параметры выполнения Объект с необязательными полями: 1. memory : объем памяти, выделяемый для функции, возможные значения: «128 МБ», «256 МБ», «512 МБ», «1 ГБ», «2 ГБ», «4 ГБ» и «8 ГБ». . 2. timeoutSeconds : таймаут функции в секундах, возможные значения от 0 до 540. 3. failurePolicy : политика отказа функции, где логическое значение true эквивалентно предоставлению пустого объекта повтора. 4. vpcConnector : идентификатор соединителя VPC в том же проекте и регионе. 5. vpcConnectorEgressSettings : если установлен vpcConnector , можно контролировать, какой исходящий трафик будет отправляться через vpcConnector . Значение не должно быть нулевым.

Возврат:

FunctionBuilder