سازنده عملکردهای زمان‌بندی‌شده، که توسط Google Pub/Sub و Cloud Scheduler ارائه می‌شوند. کار Cloud Scheduler را توصیف می کند که برای راه اندازی یک عملکرد زمان بندی شده در فرکانس ارائه شده به کار می رود. برای اطلاعات بیشتر، [Schedule functions](/docs/functions/schedule-functions) را ببینید.
دسترسی از طریق functions.pubsub.schedule() .
امضا:
export declare class ScheduleBuilder
سازندگان
| سازنده | اصلاح کننده ها | شرح |
|---|---|---|
| (سازنده) (triggerResource، گزینه ها) | یک نمونه جدید از کلاس ScheduleBuilder می سازد |
مواد و روش ها
| روش | اصلاح کننده ها | شرح |
|---|---|---|
| onRun (هندلر) | کنترل کننده رویداد برای عملکردهای برنامه ریزی شده. هر زمان که کار زمانبندی مرتبط پیام Pub/Sub ارسال می کند، فعال می شود. | |
| retryConfig (پیکربندی) | ||
| منطقه زمانی (منطقه زمانی) |
pubsub.ScheduleBuilder.(سازنده)
یک نمونه جدید از کلاس ScheduleBuilder می سازد
امضا:
constructor(triggerResource: () => string, options: DeploymentOptions);
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| triggerResource | () => رشته | |
| گزینه ها | DeploymentOptions |
pubsub.ScheduleBuilder.onRun()
کنترل کننده رویداد برای عملکردهای برنامه ریزی شده. هر زمان که کار زمانبندی مرتبط پیام Pub/Sub ارسال می کند، فعال می شود.
امضا:
onRun(handler: (context: EventContext) => PromiseLike<any> | any): CloudFunction<unknown>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| کنترل کننده | (زمینه: EventContext ) => PromiseLike<هر> | هر | کنترل کننده ای که هر زمان که کار زمانبندی مرتبط پیام Pub/Sub ارسال می کند فعال می شود. |
برمی گرداند:
CloudFunction <ناشناخته>
تابعی که می توانید آن را صادر و اجرا کنید.
pubsub.ScheduleBuilder.retryConfig()
امضا:
retryConfig(config: ScheduleRetryConfig): ScheduleBuilder;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| پیکربندی | ScheduleRetryConfig |
برمی گرداند:
pubsub.ScheduleBuilder.timeZone()
امضا:
timeZone(timeZone: string): ScheduleBuilder;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| منطقه زمانی | رشته |
برمی گرداند: