pubsub.ScheduleBuilder class

Der Builder für geplante Funktionen, die auf Google Pub/Sub und Cloud Scheduler basieren. Beschreibt den Cloud Scheduler-Job, der bereitgestellt wird, um eine geplante Funktion mit der angegebenen Häufigkeit auszulösen. Weitere Informationen finden Sie unter [Zeitplanfunktionen](/docs/functions/schedule-functions).

Zugriff über functions.pubsub.schedule() .

Unterschrift:

export declare class ScheduleBuilder

Konstrukteure

Konstrukteur Modifikatoren Beschreibung
(Konstruktor)(triggerResource, Optionen) Konstruiert eine neue Instanz der ScheduleBuilder -Klasse

Methoden

Methode Modifikatoren Beschreibung
onRun(handler) Ereignishandler für geplante Funktionen. Wird immer dann ausgelöst, wenn der zugehörige Scheduler-Job eine Pub/Sub-Nachricht sendet.
retryConfig(config)
Zeitzone(Zeitzone)

pubsub.ScheduleBuilder.(Konstruktor)

Konstruiert eine neue Instanz der ScheduleBuilder -Klasse

Unterschrift:

constructor(triggerResource: () => string, options: DeploymentOptions);

Parameter

Parameter Typ Beschreibung
TriggerResource () => Zeichenfolge
Optionen Bereitstellungsoptionen

pubsub.ScheduleBuilder.onRun()

Ereignishandler für geplante Funktionen. Wird immer dann ausgelöst, wenn der zugehörige Scheduler-Job eine Pub/Sub-Nachricht sendet.

Unterschrift:

onRun(handler: (context: EventContext) => PromiseLike<any> | any): CloudFunction<unknown>;

Parameter

Parameter Typ Beschreibung
Handler (Kontext: EventContext ) => PromiseLike<any> | beliebig Handler, der immer dann ausgelöst wird, wenn der zugehörige Planerauftrag eine Pub/Sub-Nachricht sendet.

Kehrt zurück:

CloudFunction <unbekannt>

Eine Funktion, die Sie exportieren und bereitstellen können.

pubsub.ScheduleBuilder.retryConfig()

Unterschrift:

retryConfig(config: ScheduleRetryConfig): ScheduleBuilder;

Parameter

Parameter Typ Beschreibung
config ScheduleRetryConfig

Kehrt zurück:

ScheduleBuilder

pubsub.ScheduleBuilder.timeZone()

Unterschrift:

timeZone(timeZone: string): ScheduleBuilder;

Parameter

Parameter Typ Beschreibung
Zeitzone Zeichenfolge

Kehrt zurück:

ScheduleBuilder