预定函数的构建器，由 Google Pub/Sub 和 Cloud Scheduler 提供支持。描述为按指定频率触发预定函数的 Cloud Scheduler 作业。如需了解详情，请参阅 [安排函数运行时间](/docs/functions/schedule-functions)。
通过 functions.pubsub.schedule() 访问。
签名：
export declare class ScheduleBuilder
构造函数
| 构造函数 | 修饰符 | 说明 |
|---|---|---|
| (构造函数)(triggerResource, options) | 构造 ScheduleBuilder 类的新实例 |
方法
| 方法 | 修饰符 | 说明 |
|---|---|---|
| onRun(handler) | 预定函数的事件处理脚本。每当关联的调度器作业发送 Pub/Sub 消息时触发。 | |
| retryConfig(config) | ||
| timeZone(timeZone) |
pubsub.ScheduleBuilder.（构造函数）
构造 ScheduleBuilder 类的新实例
签名：
constructor(triggerResource: () => string, options: DeploymentOptions);
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| 触发器资源 | () =>字符串 | |
| 选项 | DeploymentOptions |
pubsub.ScheduleBuilder.onRun()
预定函数的事件处理脚本。每当关联的调度器作业发送 Pub/Sub 消息时触发。
签名：
onRun(handler: (context: EventContext) => PromiseLike<any> | any): CloudFunction<unknown>;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| handler | （上下文：EventContext）=>PromiseLike<any>|任意 | 每当关联的调度器作业发送 Pub/Sub 消息时触发的处理程序。 |
返回：
Cloud Functions<未知>
您可以导出和部署的函数。
pubsub.ScheduleBuilder.retryConfig()
签名：
retryConfig(config: ScheduleRetryConfig): ScheduleBuilder;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| config | ScheduleRetryConfig |
返回：
pubsub.ScheduleBuilder.timeZone()
签名：
timeZone(timeZone: string): ScheduleBuilder;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| 时区 | 字符串 |
返回：