O builder para funções programadas, com a tecnologia do Google Pub/Sub e do Cloud Scheduler. Descreve o job do Cloud Scheduler que é implantado para acionar uma função programada na frequência fornecida. Para mais informações, consulte [Programar funções](/docs/functions/schedule-functions).
Acesso via functions.pubsub.schedule().
Assinatura:
export declare class ScheduleBuilder
Construtores
| Construtor | Modificadores | Descrição |
|---|---|---|
| (construtor)(triggerResource, opções) | Cria uma nova instância da classe ScheduleBuilder |
Métodos
| Método | Modificadores | Descrição |
|---|---|---|
| onRun(gerenciador) | Manipulador de eventos para funções programadas. Acionado sempre que o job do programador associado envia uma mensagem do Pub/Sub. | |
| retryConfig(config) (link em inglês) | ||
| timeZone(timeZone). |
pubsub.ScheduleBuilder.(construtor)
Cria uma nova instância da classe ScheduleBuilder
Assinatura:
constructor(triggerResource: () => string, options: DeploymentOptions);
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| triggerResource | () => corda | |
| options | DeploymentOptions (em inglês) |
pubsub.ScheduleBuilder.onRun()
Manipulador de eventos para funções programadas. Acionado sempre que o job do programador associado envia uma mensagem do Pub/Sub.
Assinatura:
onRun(handler: (context: EventContext) => PromiseLike<any> | any): CloudFunction<unknown>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| handler | (contexto: EventContext) => Promessa como<qualquer> | nenhum | Gerenciador que é acionado sempre que o job do programador associado envia uma mensagem do Pub/Sub. |
Retorna:
CloudFunction<desconhecida>
Uma função que pode ser exportada e implantada.
pubsub.ScheduleBuilder.retryConfig()
Assinatura:
retryConfig(config: ScheduleRetryConfig): ScheduleBuilder;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| config | ProgramRetryConfig (em inglês) |
Retorna:
ScheduleBuilder (link em inglês)
pubsub.ScheduleBuilder.timeZone()
Assinatura:
timeZone(timeZone: string): ScheduleBuilder;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| fuso horário | string |
Retorna:
ScheduleBuilder (link em inglês)