Kreator funkcji zaplanowanych, które są obsługiwane przez usługi Google Pub/Sub i Cloud Scheduler. Opisuje zadanie Cloud Scheduler, które jest wdrażane w celu aktywowania funkcji zaplanowanej z podaną częstotliwością. Więcej informacji znajdziesz w artykule [Planowanie funkcji](/docs/functions/schedule-functions).
Dostęp przez functions.pubsub.schedule()
.
Podpis:
export declare class ScheduleBuilder
Zespoły
Zespół | Modyfikatory | Opis |
---|---|---|
(constructor)(triggerResource, options) | Tworzy nową instancję klasy ScheduleBuilder |
Metody
Metoda | Modyfikatory | Opis |
---|---|---|
onRun(obsługa) | Moduł obsługi zdarzeń dla funkcji zaplanowanych. Wywoływane za każdym razem, gdy powiązane zadanie algorytmu szeregowania wysyła wiadomość Pub/Sub. | |
retryConfig(config) | ||
Strefa czasowa(strefa czasowa) |
pubsub.ScheduleBuilder.(konstruktor)
Tworzy nową instancję klasy ScheduleBuilder
Podpis:
constructor(triggerResource: () => string, options: DeploymentOptions);
Parametry
Parametr | Typ | Opis |
---|---|---|
aktywatorzasób | () => tekst | |
opcje | DeploymentOptions (Opcje wdrażania) |
pubsub.ScheduleBuilder.onRun()
Moduł obsługi zdarzeń dla funkcji zaplanowanych. Wywoływane za każdym razem, gdy powiązane zadanie algorytmu szeregowania wysyła wiadomość Pub/Sub.
Podpis:
onRun(handler: (context: EventContext) => PromiseLike<any> | any): CloudFunction<unknown>;
Parametry
Parametr | Typ | Opis |
---|---|---|
moduł obsługi | (Kontekst: EventContext) => Obietnica<any> | wszystkie | Moduł obsługi, który jest uruchamiany za każdym razem, gdy powiązane zadanie algorytmu szeregowania wysyła wiadomość Pub/Sub. |
Zwroty:
CloudFunction<nieznana>
Funkcja, którą można wyeksportować i wdrożyć.
pubsub.ScheduleBuilder.retryConfig()
Podpis:
retryConfig(config: ScheduleRetryConfig): ScheduleBuilder;
Parametry
Parametr | Typ | Opis |
---|---|---|
konfiguracja | SchedulePonówConfig |
Zwroty:
Narzędzie do tworzenia harmonogramu
pubsub.ScheduleBuilder.timeZone()
Podpis:
timeZone(timeZone: string): ScheduleBuilder;
Parametry
Parametr | Typ | Opis |
---|---|---|
strefa czasowa | ciąg znaków |
Zwroty:
Narzędzie do tworzenia harmonogramu