Schedule interface
Uma interface que representa Agenda.
Propriedades
| do |
Um tempo após o qual nenhum trabalho será criado neste Agendamento de Trabalho. O agendamento passará para o estado concluído assim que esse prazo for passado e não houver nenhum trabalho ativo neste Agendamento de Trabalho. Se você não especificar um horário doNotRunAfter e estiver criando um agendamento de trabalho recorrente, o Agendamento de Trabalho permanecerá ativo até que você o encerre explicitamente. |
| do |
A hora mais antiga em que qualquer trabalho pode ser criado neste Agendamento de Trabalho. Se você não especificar um horário doNotRunUntil, o agendamento ficará pronto para criar trabalhos imediatamente. |
| recurrence |
O intervalo de tempo entre os horários de início de dois trabalhos sucessivos na Agenda de Trabalho. Um Agendamento de Trabalho pode ter no máximo um trabalho ativo sob ele a qualquer momento. Como um Agendamento de Trabalho pode ter no máximo um trabalho ativo sob ele a qualquer momento, se for hora de criar um novo Trabalho em um Agendamento de Trabalho, mas o trabalho anterior ainda estiver em execução, o serviço do Lote não criará o novo Trabalho até que o trabalho anterior seja concluído. Se o trabalho anterior não for concluído dentro do período startWindow da nova recurrenceInterval, nenhum novo trabalho será agendado para esse intervalo. Para trabalhos recorrentes, normalmente você deve especificar um jobManagerTask no jobSpecification. Se você não usar jobManagerTask, precisará de um processo externo para monitorar quando os Trabalhos forem criados, adicionar Tarefas aos Trabalhos e encerrar os Trabalhos prontos para a próxima recorrência. O padrão é que o agendamento não se repita: um trabalho é criado, dentro do startWindow após a hora do DoNotRunUntil, e o agendamento é concluído assim que esse trabalho é concluído. O valor mínimo é de 1 minuto. Se você especificar um valor mais baixo, o serviço do Lote rejeitará a agenda com um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação Incorreta). |
| start |
O intervalo de tempo, começando a partir do momento em que o agendamento indica que um trabalho deve ser criado, no qual um trabalho deve ser criado. Se um trabalho não for criado dentro do intervalo startWindow, a 'oportunidade' será perdida; nenhum trabalho será criado até a próxima recorrência do agendamento. Se o agendamento for recorrente e o startWindow for maior que o intervalo de recorrência, isso será equivalente a um startWindow infinito, pois o trabalho 'devido' em uma recorrênciaInterval não será levado adiante para o próximo intervalo de recorrência. O padrão é infinito. O valor mínimo é de 1 minuto. Se você especificar um valor mais baixo, o serviço do Lote rejeitará a agenda com um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação Incorreta). |
Detalhes da propriedade
doNotRunAfter
Um tempo após o qual nenhum trabalho será criado neste Agendamento de Trabalho. O agendamento passará para o estado concluído assim que esse prazo for passado e não houver nenhum trabalho ativo neste Agendamento de Trabalho. Se você não especificar um horário doNotRunAfter e estiver criando um agendamento de trabalho recorrente, o Agendamento de Trabalho permanecerá ativo até que você o encerre explicitamente.
doNotRunAfter?: Date
Valor da propriedade
Date
doNotRunUntil
A hora mais antiga em que qualquer trabalho pode ser criado neste Agendamento de Trabalho. Se você não especificar um horário doNotRunUntil, o agendamento ficará pronto para criar trabalhos imediatamente.
doNotRunUntil?: Date
Valor da propriedade
Date
recurrenceInterval
O intervalo de tempo entre os horários de início de dois trabalhos sucessivos na Agenda de Trabalho. Um Agendamento de Trabalho pode ter no máximo um trabalho ativo sob ele a qualquer momento. Como um Agendamento de Trabalho pode ter no máximo um trabalho ativo sob ele a qualquer momento, se for hora de criar um novo Trabalho em um Agendamento de Trabalho, mas o trabalho anterior ainda estiver em execução, o serviço do Lote não criará o novo Trabalho até que o trabalho anterior seja concluído. Se o trabalho anterior não for concluído dentro do período startWindow da nova recurrenceInterval, nenhum novo trabalho será agendado para esse intervalo. Para trabalhos recorrentes, normalmente você deve especificar um jobManagerTask no jobSpecification. Se você não usar jobManagerTask, precisará de um processo externo para monitorar quando os Trabalhos forem criados, adicionar Tarefas aos Trabalhos e encerrar os Trabalhos prontos para a próxima recorrência. O padrão é que o agendamento não se repita: um trabalho é criado, dentro do startWindow após a hora do DoNotRunUntil, e o agendamento é concluído assim que esse trabalho é concluído. O valor mínimo é de 1 minuto. Se você especificar um valor mais baixo, o serviço do Lote rejeitará a agenda com um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação Incorreta).
recurrenceInterval?: string
Valor da propriedade
string
startWindow
O intervalo de tempo, começando a partir do momento em que o agendamento indica que um trabalho deve ser criado, no qual um trabalho deve ser criado. Se um trabalho não for criado dentro do intervalo startWindow, a 'oportunidade' será perdida; nenhum trabalho será criado até a próxima recorrência do agendamento. Se o agendamento for recorrente e o startWindow for maior que o intervalo de recorrência, isso será equivalente a um startWindow infinito, pois o trabalho 'devido' em uma recorrênciaInterval não será levado adiante para o próximo intervalo de recorrência. O padrão é infinito. O valor mínimo é de 1 minuto. Se você especificar um valor mais baixo, o serviço do Lote rejeitará a agenda com um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação Incorreta).
startWindow?: string
Valor da propriedade
string