Partilhar via

ScheduleRecurrence Classe

  • Referência

Define a frequência, o intervalo e a hora de início de um pipeline Schedule.

ScheduleRecurrence também lhe permite especificar o fuso horário e as horas ou minutos ou dias da semana para a periodicidade.

Inicializar uma periodicidade de agenda.

Também permite especificar o fuso horário e as horas ou minutos ou dias da semana para a periodicidade.

Herança
builtins.object
ScheduleRecurrence

Construtor

ScheduleRecurrence(frequency, interval, start_time=None, time_zone=None, hours=None, minutes=None, week_days=None, time_of_day=None)

Parâmetros

Name Description
frequency
Necessário
str

A unidade de tempo que descreve a frequência com que a agenda é acionada. Pode ser "Minuto", "Hora", "Dia", "Semana" ou "Mês".
interval
Necessário
int

Um valor que especifica a frequência com que a agenda é acionada com base na frequência, que é o número de unidades de tempo a aguardar até que a agenda seja acionada novamente.
start_time
datetime ou str

Um objeto datetime que descreve a data e hora de início. O tzinfo do objeto datetime não deve ser nenhum, utilize time_zone a propriedade para especificar um fuso horário, se necessário. Também pode especificar este parâmetro como uma cadeia neste formato: AAAA-MM-DDThh:mm:ss. Se Nenhum for fornecido, a primeira carga de trabalho é executada instantaneamente e as cargas de trabalho futuras são executadas com base na agenda. Se a hora de início estiver no passado, a primeira carga de trabalho será executada no próximo tempo de execução calculado.

Se start_time corresponder week_days a e time_of_day (ou hours e minutes), a primeira carga de trabalho não é executada em start_time, mas é executada no próximo tempo de execução calculado.

Default value: None
time_zone
TimeZone

Especifique o fuso horário do start_time. Se nenhuma for fornecida UTC, é utilizado.

Default value: None
hours
list[int]

Se especificar "Dia" ou "Semana" para frequência, pode especificar um ou mais números inteiros de 0 a 23, separados por vírgulas, como as horas do dia em que pretende executar o fluxo de trabalho. Por exemplo, se especificar "10", "12" e "14", obtém 10:00, 12:00 e 14:00 como as marcas de hora. Nota: apenas time_of_day ou hours e minutes podem ser utilizados.

Default value: None
minutes
list[int]

Se especificar "Dia" ou "Semana" para frequência, pode especificar um ou mais números inteiros de 0 a 59, separados por vírgulas, como os minutos da hora em que pretende executar o fluxo de trabalho. Por exemplo, pode especificar "30" como marca de minuto e, utilizando o exemplo anterior para horas do dia, obtém as 10:30, as 12:30 e as 14:30. Nota: apenas time_of_day ou hours e minutes podem ser utilizados.

Default value: None
week_days
list[str]

Se especificar "Semana" para frequência, pode especificar um ou mais dias, separados por vírgulas, quando pretender executar o fluxo de trabalho: "Segunda-feira", "Terça-feira", "Quarta-feira", "Quinta-feira", "Sexta-feira", "Sábado" e "Domingo".

Default value: None
time_of_day
str

Se especificar "Dia" ou "Semana" para frequência, pode especificar uma hora do dia para a agenda ser executada como uma cadeia no formulário hh:mm. Por exemplo, se especificar "15:30", a agenda será executada às 15:30. Nota: only time_of_day ou hours e minutes pode ser utilizado.

Default value: None
frequency
Necessário
str

A unidade de tempo que descreve a frequência com que a agenda é acionada. Pode ser "Minuto", "Hora", "Dia", "Semana" ou "Mês".
interval
Necessário
int

Um valor que especifica a frequência com que a agenda é acionada com base na frequência, que é o número de unidades de tempo a aguardar até que a agenda seja acionada novamente.
start_time
Necessário
datetime ou str

Um objeto datetime que descreve a data e hora de início. O tzinfo do objeto datetime não deve ser nenhum, utilize time_zone propriedade para especificar um fuso horário, se necessário. Também pode ser uma cadeia neste formato: AAAA-MM-DDThh:mm:ss. Se Nenhum for fornecido, a primeira carga de trabalho é executada instantaneamente e as cargas de trabalho futuras são executadas com base na agenda. Se a hora de início estiver no passado, a primeira carga de trabalho será executada no próximo tempo de execução calculado.

Se start_time corresponder week_days a e time_of_day (ou hours e minutes), a primeira carga de trabalho não é executada em start_time, mas é executada no próximo tempo de execução calculado.
time_zone
Necessário
TimeZone

Especifique o fuso horário do start_time. Se nenhuma for fornecida UTC, é utilizado.
hours
Necessário
list[int]

Se especificar "Dia" ou "Semana" para frequência, pode especificar um ou mais números inteiros de 0 a 23, separados por vírgulas, como as horas do dia em que pretende executar o fluxo de trabalho. Por exemplo, se especificar "10", "12" e "14", obtém 10:00, 12:00 e 14:00 como as marcas de hora. Nota: só podem ser utilizados time_of_day ou horas e minutos.
minutes
Necessário
list[int]

Se especificar "Dia" ou "Semana" para frequência, pode especificar um ou mais números inteiros de 0 a 59, separados por vírgulas, como os minutos da hora em que pretende executar o fluxo de trabalho. Por exemplo, pode especificar "30" como marca de minuto e, utilizando o exemplo anterior para horas do dia, obtém as 10:30, as 12:30 e as 14:30. Nota: só podem ser utilizados time_of_day ou horas e minutos.
week_days
Necessário
list[str]

Se especificar "Semana" para frequência, pode especificar um ou mais dias, separados por vírgulas, quando pretender executar o fluxo de trabalho: "Segunda-feira", "Terça-feira", "Quarta-feira", "Quinta-feira", "Sexta-feira", "Sábado" e "Domingo"
time_of_day
Necessário
str

Se especificar "Dia" ou "Semana" para frequência, pode especificar uma hora do dia para a agenda ser executada como uma cadeia no formulário hh:mm. Por exemplo, se especificar "15:30", a agenda será executada às 15:30. Nota: só podem ser utilizados time_of_day ou horas e minutos.

Observações

É utilizada uma ScheduleRecurrence ao criar uma Agenda para um Pipeline da seguinte forma:


   from azureml.pipeline.core import Schedule, ScheduleRecurrence

   recurrence = ScheduleRecurrence(frequency="Hour", interval=12)
   schedule = Schedule.create(workspace, name="TestSchedule", pipeline_id=pipeline.id,
                              experiment_name="experiment_name", recurrence=recurrence)

Seguem-se alguns exemplos de ScheduleRecurrences válidos:


   from azureml.pipeline.core import ScheduleRecurrence

   # Submit the Pipeline every 15 minutes
   recurrence = ScheduleRecurrence(frequency="Minute", interval=15)
   # Submit the Pipeline every 2 weeks on Monday and Wednesday at 6:30pm UTC
   recurrence = ScheduleRecurrence(frequency="Week", interval=2, week_days=["Monday", "Wednesday"],
                                   time_of_day="18:30")
   # Submit the Pipeline on the first day of every month starting November 1, 2019 at 9AM
   recurrence = ScheduleRecurrence(frequency="Month", interval=1, start_time="2019-11-01T09:00:00")
   # Submit the Pipeline every hour on the 55th minute starting on January 13th, 2020 at 12:55pm
   # if the specified start time is in the past, the first workload is run at the next future 55th minute
   # of the hour.
   recurrence = ScheduleRecurrence(frequency="Hour", interval=1, start_time="2020-01-13T12:55:00")

Métodos

validate

Valide a periodicidade da agenda.

validate

Valide a periodicidade da agenda.

validate()