BatchJobScheduleConfiguration interface
ジョブが作成されるスケジュール。 すべての時刻は UTC にそれぞれ固定され、夏時間の影響を受けません。
プロパティ
| do |
この期間以降、このジョブスケジュールの下で職は作成されません。 この期限を過ぎて、このスケジュールの下でアクティブな仕事がなくなった時点で、スケジュールは完了状態に移行します。 doNotRunAfter の時間を指定しておらず、繰り返しのジョブスケジュールを作成している場合、ジョブスケジュールは明示的に終了するまで有効のままです。 |
| do |
このジョブスケジュールの下でジョブが作成される最も早い時期。 doNotRunTiルを指定しなければ、スケジュールはすぐにジョブ作成の準備が整います。 |
| recurrence |
ジョブスケジュールの下で、連続した2つのジョブの開始時刻の間の時間間隔。 ジョブスケジュールの下には、常に最大1つのアクティブなジョブが存在します。 ジョブスケジュールは最大1つのアクティブなジョブを同時に持つことができないため、新しいジョブを作成するタイミングで前のジョブがまだ稼働している場合、バッチサービスは前のジョブが完了するまで新しいジョブを作成しません。 前のジョブが新しいrecurrenceIntervalのstartWindow期間内に完了しなかった場合、その期間中に新しいジョブはスケジューリングされません。 繰り返し発生するジョブの場合、通常はjobSpecificationでjobManagerTaskを指定するべきです。 jobManagerTaskを使わない場合は、ジョブ作成を監視し、ジョブに追加し、次の再帰のためにジョブを終了させる外部プロセスが必要です。 デフォルトではスケジュールは再発しません。doNotRunTiルの後のstartWindow内に1つのジョブが作成され、そのジョブが完了するとすぐにスケジュールが完了します。 最低限の時間は1分です。 より低い値を指定すると、バッチサービスはエラーでスケジュールを拒否します。REST APIを直接呼び出している場合、HTTPステータスコードは400(Bad Request)です。 |
| start |
スケジュールがジョブを作成するべき時刻から始まる時間間隔で、その時間内にジョブを作成しなければなりません。 もしジョブがstartWindow間隔内に作成されなければ、その「機会」は失われます。次のスケジュールの再発行までジョブは作成されません。 スケジュールが繰り返される場合、そしてstartWindowが再帰間隔より長い場合、これは無限のstartWindowと同等です。なぜなら、あるrecurrenceIntervalで「期限」となっているジョブは次の再帰間隔に持ち越されないからです。 デフォルトは無限です。 最低限の時間は1分です。 より低い値を指定すると、バッチサービスはエラーでスケジュールを拒否します。REST APIを直接呼び出している場合、HTTPステータスコードは400(Bad Request)です。 |
プロパティの詳細
doNotRunAfter
この期間以降、このジョブスケジュールの下で職は作成されません。 この期限を過ぎて、このスケジュールの下でアクティブな仕事がなくなった時点で、スケジュールは完了状態に移行します。 doNotRunAfter の時間を指定しておらず、繰り返しのジョブスケジュールを作成している場合、ジョブスケジュールは明示的に終了するまで有効のままです。
doNotRunAfter?: Date
プロパティ値
Date
doNotRunUntil
このジョブスケジュールの下でジョブが作成される最も早い時期。 doNotRunTiルを指定しなければ、スケジュールはすぐにジョブ作成の準備が整います。
doNotRunUntil?: Date
プロパティ値
Date
recurrenceInterval
ジョブスケジュールの下で、連続した2つのジョブの開始時刻の間の時間間隔。 ジョブスケジュールの下には、常に最大1つのアクティブなジョブが存在します。 ジョブスケジュールは最大1つのアクティブなジョブを同時に持つことができないため、新しいジョブを作成するタイミングで前のジョブがまだ稼働している場合、バッチサービスは前のジョブが完了するまで新しいジョブを作成しません。 前のジョブが新しいrecurrenceIntervalのstartWindow期間内に完了しなかった場合、その期間中に新しいジョブはスケジューリングされません。 繰り返し発生するジョブの場合、通常はjobSpecificationでjobManagerTaskを指定するべきです。 jobManagerTaskを使わない場合は、ジョブ作成を監視し、ジョブに追加し、次の再帰のためにジョブを終了させる外部プロセスが必要です。 デフォルトではスケジュールは再発しません。doNotRunTiルの後のstartWindow内に1つのジョブが作成され、そのジョブが完了するとすぐにスケジュールが完了します。 最低限の時間は1分です。 より低い値を指定すると、バッチサービスはエラーでスケジュールを拒否します。REST APIを直接呼び出している場合、HTTPステータスコードは400(Bad Request)です。
recurrenceInterval?: string
プロパティ値
string
startWindow
スケジュールがジョブを作成するべき時刻から始まる時間間隔で、その時間内にジョブを作成しなければなりません。 もしジョブがstartWindow間隔内に作成されなければ、その「機会」は失われます。次のスケジュールの再発行までジョブは作成されません。 スケジュールが繰り返される場合、そしてstartWindowが再帰間隔より長い場合、これは無限のstartWindowと同等です。なぜなら、あるrecurrenceIntervalで「期限」となっているジョブは次の再帰間隔に持ち越されないからです。 デフォルトは無限です。 最低限の時間は1分です。 より低い値を指定すると、バッチサービスはエラーでスケジュールを拒否します。REST APIを直接呼び出している場合、HTTPステータスコードは400(Bad Request)です。
startWindow?: string
プロパティ値
string