Google Pub/Sub ve Cloud Scheduler tarafından desteklenen planlanmış işlevler için oluşturucu. Planlanmış bir işlevi sağlanan sıklıkta tetiklemek için dağıtılan Cloud Scheduler işini açıklar. Daha fazla bilgi için [Program işlevleri](/docs/functions/schedule-functions) sayfasına bakın.
functions.pubsub.schedule()
üzerinden erişim.
İmza:
export declare class ScheduleBuilder
Markalar
Marka | Değiştiriciler | Açıklama |
---|---|---|
(oluşturucu)(triggerResource, options) | ScheduleBuilder sınıfının yeni bir örneğini oluşturur |
Yöntemler
Yöntem | Değiştiriciler | Açıklama |
---|---|---|
onRun(işleyici) | Planlanmış işlevler için etkinlik işleyici. İlişkili planlayıcı işi bir Pub/Sub mesajı gönderdiğinde tetiklenir. | |
retryConfig(config) | ||
timeZone(timeZone) |
pubsub.ScheduleBuilder.(kurucu)
ScheduleBuilder
sınıfının yeni bir örneğini oluşturur
İmza:
constructor(triggerResource: () => string, options: DeploymentOptions);
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
tetikleyiciKaynak | () => dize | |
seçenekler | DeploymentOptions |
pubsub.ScheduleBuilder.onRun()
Planlanmış işlevler için etkinlik işleyici. İlişkili planlayıcı işi bir Pub/Sub mesajı gönderdiğinde tetiklenir.
İmza:
onRun(handler: (context: EventContext) => PromiseLike<any> | any): CloudFunction<unknown>;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
handler | (bağlam: EventContext) => PromiseBeğen<herhangi biri> | herhangi biri | İlişkili planlayıcı işi bir Pub/Sub mesajı gönderdiğinde tetiklenen işleyici. |
Şunu döndürür:
CloudFunction<bilinmiyor>
Dışa aktarabileceğiniz ve dağıtabileceğiniz bir işlev.
pubsub.ScheduleBuilder.retryConfig()
İmza:
retryConfig(config: ScheduleRetryConfig): ScheduleBuilder;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
yapılandırma | ScheduleRetryConfig |
Şunu döndürür:
pubsub.ScheduleBuilder.timeZone()
İmza:
timeZone(timeZone: string): ScheduleBuilder;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
saat dilimi | dize |
Şunu döndürür: