pubsub.ScheduleBuilder class

Compilador para funciones programadas con la tecnología de Google Pub/Sub y Cloud Scheduler. Describe el trabajo de Cloud Scheduler que se implementa para activar una función programada con la frecuencia proporcionada. Para obtener más información, consulta [Cómo programar funciones](/docs/functions/schedule-functions).

Acceso a través de functions.pubsub.schedule().

Firma:

export declare class ScheduleBuilder

Constructores

Constructor Teclas modificadoras Descripción
(constructor)(triggerResource, opciones) Construye una instancia nueva de la clase ScheduleBuilder.

Métodos

Método Teclas modificadoras Descripción
onRun(controlador) Controlador de eventos para funciones programadas. Se activa cada vez que el trabajo de programador asociado envía un mensaje de Pub/Sub.
retryConfig(config)
timeZone(timeZone)

pubsub.ScheduleBuilder.(constructor)

Construye una instancia nueva de la clase ScheduleBuilder.

Firma:

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

Parámetros

Parámetro Tipo Descripción
Recurso activador () => cadena
opciones Opciones de implementación

pubsub.ScheduleBuilder.onRun()

Controlador de eventos para funciones programadas. Se activa cada vez que el trabajo de programador asociado envía un mensaje de Pub/Sub.

Firma:

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

Parámetros

Parámetro Tipo Descripción
handler (contexto: EventContext) => Promesa como<cualquiera> | cualquiera Controlador que se activa cada vez que el trabajo del programador asociado envía un mensaje de Pub/Sub.

Muestra:

Cloud Function<desconocido>

Una función que puedes exportar y, luego, implementar.

pubsub.ScheduleBuilder.retryConfig()

Firma:

retryConfig(config: ScheduleRetryConfig): ScheduleBuilder;

Parámetros

Parámetro Tipo Descripción
config ScheduleRetryConfig

Muestra:

ScheduleBuilder

pubsub.ScheduleBuilder.timeZone()

Firma:

timeZone(timeZone: string): ScheduleBuilder;

Parámetros

Parámetro Tipo Descripción
Zona horaria string

Muestra:

ScheduleBuilder