O construtor para funções agendadas, que são fornecidas pelo Google Pub/Sub e Cloud Scheduler. Descreve o trabalho do Cloud Scheduler implantado para acionar uma função agendada na frequência fornecida. Para obter mais informações, consulte [Funções de agendamento](/docs/functions/schedule-functions).
Acesso via functions.pubsub.schedule() .
Assinatura:
export declare class ScheduleBuilder
Construtores
| Construtor | Modificadores | Descrição |
|---|---|---|
| (construtor)(triggerResource, opções) | Constrói uma nova instância da classe ScheduleBuilder |
Métodos
| Método | Modificadores | Descrição |
|---|---|---|
| onRun(manipulador) | Manipulador de eventos para funções agendadas. Acionado sempre que o trabalho do agendador associado envia uma mensagem do Pub/Sub. | |
| retryConfig(config) | ||
| timeZone(timeZone) |
pubsub.ScheduleBuilder.(construtor)
Constrói uma nova instância da classe ScheduleBuilder
Assinatura:
constructor(triggerResource: () => string, options: DeploymentOptions);
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| triggerResource | () => string | |
| opções | Opções de implantação |
pubsub.ScheduleBuilder.onRun()
Manipulador de eventos para funções agendadas. Acionado sempre que o trabalho do agendador associado envia uma mensagem do Pub/Sub.
Assinatura:
onRun(handler: (context: EventContext) => PromiseLike<any> | any): CloudFunction<unknown>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| manipulador | (contexto: EventContext ) => PromiseLike<qualquer> | qualquer | Manipulador que é acionado sempre que o trabalho do agendador associado envia uma mensagem do Pub/Sub. |
Retorna:
CloudFunction <desconhecido>
Uma função que você pode exportar e implantar.
pubsub.ScheduleBuilder.retryConfig()
Assinatura:
retryConfig(config: ScheduleRetryConfig): ScheduleBuilder;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| configuração | ScheduleRetryConfig |
Retorna:
pubsub.ScheduleBuilder.timeZone()
Assinatura:
timeZone(timeZone: string): ScheduleBuilder;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| fuso horário | corda |
Retorna: