定期的なスケジュール設定されたイベントの開始条件

3 つの開始条件を使用して、自動化を事前にスケジュールできます。

1. Time.ScheduledTimeEvent
2. Time.RecurringClockTimeScheduledEvent
3. Time.RecurringSolarTimeScheduledEvent

最初の Time.ScheduledTimeEvent を使用すると、時刻または太陽イベント（日の出や日の入り）に基づいて、将来の特定の瞬間に自動化を開始するか、自動化を繰り返し開始するようにスケジュールを設定できます。

たとえば、この開始条件は毎日午後 10 時に自動化を開始します。

starter<_>(structure, Time.ScheduledTimeEvent) {
  parameter(Time.ScheduledTimeEvent.clockTime(LocalTime.of(22, 0, 0, 0)))
}

または、時計の時間ではなく、太陽時のイベントを指定することもできます。このタイプの開始条件のパラメータは、次の要素で構成される SolarTimeStruct です。

1. type（SolarTimeType.Sunrise または SolarTimeType.Sunset）。
2. offset: 太陽イベントを基準として開始時間を任意の時間にシフトできます。正の値を指定すると、ソーラー イベントの後に遅延が発生します。負の値を指定すると、ソーラー イベントの前にスターターがトリガーされます。

次の例は、毎日日の出の 15 分前に自動化を開始する開始条件です。

starter<_>(structure, Time.ScheduledTimeEvent) {
  parameter(
    Time.ScheduledTimeEvent.solarTime(
      SolarTimeStruct(SolarTimeType.Sunrise, java.time.Duration.ofMinutes(-15))
    )
  )
}

残りの 2 つの開始条件は、定期的なスケジュール設定イベントの開始条件です。これにより、時間ベースとカレンダーベースの両方の条件を含む、より具体的な条件に従って定期的に実行される自動化を作成できます。

Time.RecurringClockTimeScheduledEvent を使用すると、1 つ以上の時間または日付の条件に基づいて自動化のスケジュールを設定できます。この開始条件では、Unix cron ユーティリティで使用される構文に似た構文を使用して、自動化のスケジュールを指定します。

Time.RecurringSolarTimeScheduledEvent を使用すると、日の出または日の入りの時刻に基づいて自動化をスケジュールできます。必要に応じて、カレンダーベースの条件と組み合わせることもできます。

cron 式

cron は、Unix システムと Linux システムで定期的なジョブのスケジュール設定に使用されるコマンドです。

定期的なスケジュール設定イベントの開始条件では、cron で使用されるものと類似したスケジュール設定式の構文が使用されます。このため、これらの開始条件で使用されるスケジュール設定式は cron 式と呼ばれます。

cron にはいくつかの「フレーバー」があり、これらの実装間で構文が異なります。定期的なスケジュール設定イベントの開始 cron 式は、Quartz スケジューラと同じ構文を使用します。Quartz の cron 式の構文については、Quartz の CronExpression のドキュメントをご覧ください。

例

以下に例を示します。

ユースケース	秒	分	時間	日	月	曜日	年
24 時間ごとに午前 0 時に実行	0	0	0	?	*	*	*
毎週火曜日の午前 6 時に実行	0	30	19	?	*	3	*
2 月の間、毎時 15 分に実行	0	15	*	?	2	*	*
1 時間に 1 回実行	0	0	*	?	*	*	*
1 月から 3 月まで、毎月 1 日に最も近い平日に 24 時間ごとに午前 0 時に実行	0	0	0	?	1-3	1W	*
2 月の第 2 木曜日、1 時間に 1 回、15 分	0	15	*	?	2	5#2	*
2 月の最終日、毎時 15 分ごとに実行	0	15	*	L	2	?	*
毎週火曜日と木曜日の午前 6 時に実行	0	30	19	?	*	3,5	*

RecurringClockTimeScheduledEvent

RecurringClockTimeScheduledEvent 開始条件では、cron 式文字列が Time.RecurringClockTimeScheduledEvent.cronExpression フィールドに割り当てられます。

以下は、4 月の毎週水曜日の午後 8 時に自動化を開始する RecurringClockTimeScheduledEvent 開始条件の例です。

starter<_>(structure, event = Time.RecurringClockTimeScheduledEvent) {
  parameter(Time.RecurringClockTimeScheduledEvent.cronExpression("0 0 20 ? 4 4 *"))
}

RecurringSolarTimeScheduleEvent

RecurringSolarTimeScheduleEvent 開始子は 2 つのパラメータを取ります。

1. SolarTimeStruct。
2. cronExpression: 日付、月、曜日、年のフィールドのみで構成される cron 式のサブセット。自動化の開始時刻は太陽時で指定するため、秒、分、時間のフィールドは省略されます。

次の例は、4 月の毎週水曜日に日の出の 1 時間後に自動化を開始する開始条件です。

starter<_>(structure, event = Time.RecurringSolarTimeScheduledEvent) {
  parameter(
    Time.RecurringSolarTimeScheduledEvent.solarTime(
      TimeTrait.SolarTimeStruct(SolarTimeType.Sunrise, Duration.ofHours(1))
    )
  )
  parameter(Time.RecurringSolarTimeScheduledEvent.cronExpression("? 4 4 *"))
}