ScheduleRecurrence クラス

パイプライン Schedule の頻度、間隔、開始時刻を定義します。

ScheduleRecurrence では、タイム ゾーンと、繰り返しの時間、分、または曜日を指定できます。

スケジュールの繰り返しを初期化します。

また、タイム ゾーンと、繰り返しの時間または分または週の日を指定することもできます。

継承

builtins.object

ScheduleRecurrence

コンストラクター

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

パラメーター

名前	説明
frequency 必須	str スケジュールの起動間隔を表す時間の単位。 "Minute"、"Hour"、"Day"、"Week"、または "Month" を指定できます。
interval 必須	int スケジュールの起動間隔を頻度に基づいて指定する値。頻度は、スケジュールが再び起動するまで待機する時間の単位数です。
start_time	datetime または str 開始日時を表す datetime オブジェクト。 datetime オブジェクトの tzinfo は none である必要があります。必要な場合は、time_zone プロパティを使用してタイム ゾーンを指定します。 このパラメーターは、YYYY-MM-DDThh:mm:ss の形式で文字列として指定することもできます。 None を指定した場合、最初のワークロードはすぐに実行され、将来のワークロードはスケジュールに基づいて実行されます。 開始時刻が過去の場合、最初のワークロードは、計算された次の実行時に実行されます。 start_time が week_days と time_of_day (または hours と minutes) に一致する場合、最初のワークロードは start_time には実行されず、次回の計算された実行時間に実行されます。 規定値: None
time_zone	TimeZone start_time のタイム ゾーンを指定します。 None を指定した場合、UTC が使用されます。 規定値: None
hours	list[int] 頻度に "Day" または "Week" を指定した場合、ワークフローを実行する時刻として 0 ～ 23 の 1 つまたは複数の整数をコンマ区切りで指定できます。 たとえば "10"、"12"、"14" を指定した場合、時刻のマークとして 10 AM、12 PM、2 PM が取得されます。 注: 使用できるのは、time_of_day か、hours と minutes のみです。 規定値: None
minutes	list[int] 頻度に "Day" または "Week" を指定した場合、ワークフローを実行する時刻の分として 0 ～ 59 の 1 つまたは複数の整数をコンマ区切りで指定できます。 たとえば上の例で指定した時を使用し、分の要素に「30」を指定した場合、実行時刻は 10:30 AM、12:30 PM、2:30 PM となります。 注: 使用できるのは、time_of_day か、hours と minutes のみです。 規定値: None
week_days	list[str] 頻度に "Week" を指定した場合、ワークフローを実行する 1 日または複数の日 ("Monday"、"Tuesday"、"Wednesday"、"Thursday"、"Friday"、"Saturday"、および "Sunday") をコンマ区切りで指定できます。 規定値: None
time_of_day	str 頻度に "Day" または "Week" を指定する場合は、スケジュールを実行する時間帯を hh:mm という形式の文字列で指定できます。 たとえば、"15:30" と指定すると、スケジュールは午後 3 時 30 分に実行されます。 注: only time_of_day または hours と minutes を使用できます。 規定値: None
frequency 必須	str スケジュールの起動間隔を表す時間の単位。 "Minute"、"Hour"、"Day"、"Week"、または "Month" を指定できます。
interval 必須	int スケジュールの起動間隔を頻度に基づいて指定する値。頻度は、スケジュールが再び起動するまで待機する時間の単位数です。
start_time 必須	datetime または str 開始日時を表す datetime オブジェクト。 datetime オブジェクトの tzinfo は none にする必要があります。必要に応じて、time_zone プロパティを使用してタイム ゾーンを指定します。 YYYY-MM-DDThh:mm:ss という形式の文字列を指定することもできます。 None が指定されている場合、最初のワークロードは即座に実行され、将来のワークロードはスケジュールに基づいて実行されます。 開始時刻が過去の場合、最初のワークロードは、計算された次の実行時に実行されます。 start_time が week_days と time_of_day (または hours と minutes) に一致する場合、最初のワークロードは start_time には実行されず、次回の計算された実行時間に実行されます。
time_zone 必須	TimeZone start_timeのタイム ゾーンを指定します。 None を指定した場合、UTC が使用されます。
hours 必須	list[int] 頻度に "Day" または "Week" を指定した場合、ワークフローを実行する時刻として 0 ～ 23 の 1 つまたは複数の整数をコンマ区切りで指定できます。 たとえば "10"、"12"、"14" を指定した場合、時刻のマークとして 10 AM、12 PM、2 PM が取得されます。 注: time_of_dayまたは時間と分のみを使用できます。
minutes 必須	list[int] 頻度に "Day" または "Week" を指定した場合、ワークフローを実行する時刻の分として 0 ～ 59 の 1 つまたは複数の整数をコンマ区切りで指定できます。 たとえば上の例で指定した時を使用し、分の要素に「30」を指定した場合、実行時刻は 10:30 AM、12:30 PM、2:30 PM となります。 注: time_of_dayまたは時間と分のみを使用できます。
week_days 必須	list[str] 頻度に "週" を指定する場合は、ワークフローを実行するときに、"月曜日"、"火曜日"、"水曜日"、"木曜日"、"金曜日"、"土曜日"、"日曜日" の 1 日以上をコンマで区切って指定できます。
time_of_day 必須	str 頻度に "Day" または "Week" を指定する場合は、スケジュールを実行する時間帯を hh:mm という形式の文字列で指定できます。 たとえば、"15:30" と指定すると、スケジュールは午後 3 時 30 分に実行されます。 注: time_of_dayまたは時間と分のみを使用できます。

注釈

ScheduleRecurrence は、パイプラインのスケジュールを作成するときに、次のように使用されます。

   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)

次に、いくつかの有効な ScheduleRecurrences の例を示します。

   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")

メソッド

validate

スケジュール繰り返しを検証します。

validate

スケジュール繰り返しを検証します。

validate()