インターフェース JobExplorer
- すべての既知の実装クラス:
SimpleJobExplorer
public interface JobExplorer
実行中または履歴のジョブとステップの実行を参照するためのエントリポイント。データは永続ストレージから再水和される可能性があるため、実行がアクティブだったときに存在していたであろう揮発性フィールドを含めることはできません。
- 導入:
- 2.0
- 作成者:
- Dave Syer, Michael Minella, Will Schipp, Mahmoud Ben Hassine, Parikshit Dutta
メソッドのサマリー
修飾子と型メソッド説明findJobInstancesByJobName
(StringSE jobName, int start, int count) 'like' またはワイルドカード条件を使用して、作成 (したがって、通常は最初の実行) の降順でJobInstance
値をフェッチします。findRunningJobExecutions
(StringSE jobName) 実行中のジョブの実行を取得します。getJobExecution
(LongSE executionId) ID でJobExecution
を取得します。getJobExecutions
(JobInstance jobInstance) ジョブインスタンスごとにジョブの実行を取得します。getJobInstance
(LongSE instanceId) default JobInstance
getJobInstance
(StringSE jobName, JobParameters jobParameters) long
getJobInstanceCount
(StringSE jobName) 指定されたジョブ名に関連付けられた固有のJobInstance
オブジェクトの数をリポジトリに照会します。getJobInstances
(StringSE jobName, int start, int count) JobInstance
値は、作成の降順 (したがって、通常は最初の実行の順) に取得します。一意のすべてのJobInstance
名(アルファベット順にソート)をリポジトリに照会します。default JobExecution
getLastJobExecution
(JobInstance jobInstance) 特定のJobInstance
に対して作成された最後のJobExecution
を見つけます。default JobInstance
getLastJobInstance
(StringSE jobName) 指定されたジョブの最後のジョブインスタンスを ID で検索します。getStepExecution
(LongSE jobExecutionId, LongSE stepExecutionId) ID と親JobExecution
ID によってStepExecution
を取得します。
メソッドの詳細
getJobInstances
JobInstance
値は、作成の降順 (したがって、通常は最初の実行の順) に取得します。- パラメーター:
jobName
- 照会するジョブの名前。start
- 返されるインスタンスの開始インデックス。count
- 返されるインスタンスの最大数。- 戻り値:
- 最大 count 値までの
JobInstance
値。
getLastJobInstance
指定されたジョブの最後のジョブインスタンスを ID で検索します。- パラメーター:
jobName
- ジョブの名前。- 戻り値:
- 存在する場合は Id、それ以外の場合は
null
による最後のジョブインスタンス。 - 導入:
- 4.2
getJobExecution
ID でJobExecution
を取得します。親のJobInstance
と関連するExecutionContext
およびStepExecution
インスタンス (実行コンテキストも含む) を含む、この実行の完全なオブジェクトグラフが返される必要があります (特に指定がない限り)。- パラメーター:
executionId
- ジョブ実行 ID。- 戻り値:
- この ID を持つ
JobExecution
または見つからない場合はnull
。
getStepExecution
@Nullable StepExecution getStepExecution(@Nullable LongSE jobExecutionId, @Nullable LongSE stepExecutionId) ID と親JobExecution
ID によってStepExecution
を取得します。ステップの実行コンテキストは結果で利用可能である必要があり、親ジョブの実行にはプリミティブプロパティが必要ですが、ジョブインスタンス情報が含まれていない場合があります。- パラメーター:
jobExecutionId
- 親ジョブの実行 ID。stepExecutionId
- ステップ実行 ID。- 戻り値:
- この ID を持つ
StepExecution
または見つからない場合はnull
。 - 関連事項:
getJobInstance
- パラメーター:
instanceId
-Long
SE 取得するJobInstance
の ID。- 戻り値:
- この ID を持つ
JobInstance
、または見つからない場合はnull
。
getJobInstance
- パラメーター:
jobName
-String
SE ジョブの名前。jobParameters
- ジョブインスタンスのJobParameters
パラメーター。- 戻り値:
- 指定された名前とパラメーターを持つ
JobInstance
、またはnull
。 - 導入:
- 5.0
getJobExecutions
ジョブインスタンスごとにジョブ実行を取得します。実装によっては、対応するステップの実行が完全にハイドレートされない場合があります (たとえば、実行コンテキストが欠落している可能性があります)。その場合はgetStepExecution(Long, Long)
で水分補給してください。- パラメーター:
jobInstance
- 照会するJobInstance
。- 戻り値:
- 指定された
JobInstance
のすべての実行のリスト。
getLastJobExecution
特定のJobInstance
に対して作成された最後のJobExecution
を見つけます。- パラメーター:
jobInstance
- 最後のJobExecution
を検索するJobInstance
。- 戻り値:
- このインスタンスに対して作成された最後の
JobExecution
、または指定されたジョブインスタンスに対してジョブの実行が見つからない場合はnull
。 - 導入:
- 4.2
findRunningJobExecutions
実行中のジョブ実行を取得します。実装によっては、対応するステップの実行が完全にハイドレートされない場合があります (たとえば、実行コンテキストが欠落している可能性があります)。その場合はgetStepExecution(Long, Long)
で水分補給してください。- パラメーター:
jobName
- ジョブの名前。- 戻り値:
- 指定された名前を持つジョブの実行中の実行のセット。
getJobNames
一意のすべてのJobInstance
名(アルファベット順にソート)をリポジトリに照会します。- 戻り値:
- 実行されたジョブ名のリスト。
findJobInstancesByJobName
'like' またはワイルドカード条件を使用して、作成 (したがって、通常は最初の実行) の降順でJobInstance
値をフェッチします。- パラメーター:
jobName
- 照会するジョブの名前。start
- 返されるインスタンスの開始インデックス。count
- 返されるインスタンスの最大数。- 戻り値:
- リクエストされたジョブ名の
JobInstance
のリスト。
getJobInstanceCount
指定されたジョブ名に関連付けられた固有のJobInstance
オブジェクトの数をリポジトリに照会します。- パラメーター:
jobName
- 照会するジョブの名前。- 戻り値:
- 関連付けられたジョブリポジトリ内に存在する
JobInstance
の数。 - 例外:
NoSuchJobException
- 指定された jobName にJobInstance
がない場合にスローされます。