计划功能的构建器,由 Google Pub/Sub 和 Cloud Scheduler 提供支持。描述部署以按提供的频率触发计划功能的 Cloud Scheduler 作业。有关更多信息,请参阅[计划函数](/docs/functions/schedule-functions)。
通过functions.pubsub.schedule()
访问。
签名:
export declare class ScheduleBuilder
构造函数
构造函数 | 修饰符 | 描述 |
---|---|---|
(构造函数)(触发资源,选项) | 构造ScheduleBuilder 类的新实例 |
方法
方法 | 修饰符 | 描述 |
---|---|---|
onRun(处理程序) | 预定函数的事件处理程序。每当关联的调度程序作业发送 Pub/Sub 消息时就会触发。 | |
重试配置(配置) | ||
时区(时区) |
pubsub.ScheduleBuilder.(构造函数)
构造ScheduleBuilder
类的新实例
签名:
constructor(triggerResource: () => string, options: DeploymentOptions);
参数
范围 | 类型 | 描述 |
---|---|---|
触发资源 | () => 字符串 | |
选项 | 部署选项 |
pubsub.ScheduleBuilder.onRun()
预定函数的事件处理程序。每当关联的调度程序作业发送 Pub/Sub 消息时就会触发。
签名:
onRun(handler: (context: EventContext) => PromiseLike<any> | any): CloudFunction<unknown>;
参数
范围 | 类型 | 描述 |
---|---|---|
处理程序 | (上下文: EventContext ) => PromiseLike<任意> |任何 | 每当关联的调度程序作业发送 Pub/Sub 消息时就会触发的处理程序。 |
返回:
云函数<未知>
您可以导出和部署的函数。
pubsub.ScheduleBuilder.retryConfig()
签名:
retryConfig(config: ScheduleRetryConfig): ScheduleBuilder;
参数
范围 | 类型 | 描述 |
---|---|---|
配置 | 计划重试配置 |
返回:
pubsub.ScheduleBuilder.timeZone()
签名:
timeZone(timeZone: string): ScheduleBuilder;
参数
范围 | 类型 | 描述 |
---|---|---|
时区 | 细绳 |
返回: