インターフェース TaskExplorer
- すべての既知の実装クラス:
SimpleTaskExplorer
public interface TaskExplorer
ユーザーが利用可能なタスク実行を照会できるようにするメソッドを提供します。
- 作成者:
- Glenn Renfro, Michael Minella, Gunnar Hillert
メソッドのサマリー
修飾子と型メソッド説明org.springframework.data.domain.Page<TaskExecution>
findAll
(org.springframework.data.domain.Pageable pageable) ページング可能な制約内のすべてのタスク実行を、開始日の降順、taskExecution ID の降順でソートして取得します。org.springframework.data.domain.Page<TaskExecution>
findRunningTaskExecutions
(StringSE taskName, org.springframework.data.domain.Pageable pageable) 指定されたタスク名を持つ taskExecutions のコレクションを取得します。org.springframework.data.domain.Page<TaskExecution>
findTaskExecutionsByName
(StringSE taskName, org.springframework.data.domain.Pageable pageable) 実行のコレクション / ページを取得します。getJobExecutionIdsByTaskExecutionId
(long taskExecutionId) リクエストされたタスクの範囲内で実行されたジョブの JobExecution ID のセットを返します。getLatestTaskExecutionForTaskName
(StringSE taskName) 指定されたタスク名の最新のタスク実行を返します。getLatestTaskExecutionsByTaskNames
(StringSE... taskNames) 1 つ以上のタスク名の最新のTaskExecution
のList
SE を返します。long
現在実行中のタスク実行数を取得します。getTaskExecution
(long executionId) TaskExecution
をその ID で取得します。long
現在のタスク実行数を取得します。long
getTaskExecutionCountByTaskName
(StringSE taskName) taskName の実行回数を取得します。getTaskExecutionIdByJobExecutionId
(long jobExecutionId) リクエストされた Spring Batch ジョブ実行がそのコンテキスト内で実行された TaskExecution の ID を返します。使用可能なタスク名のリストを取得します。
メソッドの詳細
getTaskExecution
TaskExecution
をその ID で取得します。- パラメーター:
executionId
- タスク実行 ID- 戻り値:
- この ID を持つ
TaskExecution
。見つからない場合は null
findRunningTaskExecutions
org.springframework.data.domain.Page<TaskExecution> findRunningTaskExecutions(StringSE taskName, org.springframework.data.domain.Pageable pageable) 指定されたタスク名を持つ taskExecutions のコレクションを取得します。- パラメーター:
taskName
- タスクの名前pageable
- 検索の制約- 戻り値:
- 指定された名前のタスクの実行中の実行のセット
getTaskNames
使用可能なタスク名のリストを取得します。- 戻り値:
- 実行されたタスク名のセット
getTaskExecutionCountByTaskName
taskName の実行回数を取得します。- パラメーター:
taskName
- 検索するタスクの名前- 戻り値:
- 指定されたタスク名を持つ実行中のタスクの数
getTaskExecutionCount
long getTaskExecutionCount()現在のタスク実行数を取得します。- 戻り値:
- 現在のタスク実行数。
getRunningTaskExecutionCount
long getRunningTaskExecutionCount()現在実行中のタスク実行数を取得します。- 戻り値:
- 現在実行中のタスク実行数。
findTaskExecutionsByName
org.springframework.data.domain.Page<TaskExecution> findTaskExecutionsByName(StringSE taskName, org.springframework.data.domain.Pageable pageable) 実行のコレクション / ページを取得します。- パラメーター:
taskName
- 検索するタスクの名前pageable
- 検索の制約- 戻り値:
- タスク実行のリスト
findAll
org.springframework.data.domain.Page<TaskExecution> findAll(org.springframework.data.domain.Pageable pageable) ページング可能な制約内のすべてのタスク実行を、開始日の降順、taskExecution ID の降順でソートして取得します。- パラメーター:
pageable
- 検索の制約- 戻り値:
- 検索結果を含むページ
getTaskExecutionIdByJobExecutionId
リクエストされた Spring Batch ジョブ実行がコンテキスト内で実行された TaskExecution の ID を返します。見つからない場合は null を返します。- パラメーター:
jobExecutionId
- JobExecution の ID- 戻り値:
TaskExecution
の ID
getJobExecutionIdsByTaskExecutionId
リクエストされたタスクの範囲内で実行されたジョブの JobExecution ID のセットを返します。- パラメーター:
taskExecutionId
-TaskExecution
の ID- 戻り値:
- タスク内で実行されたジョブ実行の ID の
Set
。
getLatestTaskExecutionsByTaskNames
1 つ以上のタスク名に対して、最新のTaskExecution
のList
SE を返します。最新は、最新の開始時刻によって定義されます。TaskExecution
は終了している必要はありません (結果には保留中のTaskExecution
が含まれる場合があります)。理論的には、同じ名前のTaskExecution
に、まったく同じ開始時刻のTaskExecution
が 1 つ以上ある可能性があります。その場合、最も高いタスク実行 ID を持つTaskExecution
が返されます。このメソッドは、計算で終了時刻を考慮しません。タスク実行A
がタスク実行B
の後に開始され、タスク実行A
の前に終了する場合、タスク実行B
が返されます。- パラメーター:
taskNames
- 少なくとも 1 つのタスク名を指定する必要があります- 戻り値:
- TaskExecutions のリスト。空になる可能性はありますが、null にはなりません。
getLatestTaskExecutionForTaskName
指定されたタスク名の最新のタスク実行を返します。最終的にはgetLatestTaskExecutionsByTaskNames(String...)
と同じアルゴリズムが適用されますが、返される結果は 1 つだけです。- パラメーター:
taskName
- null または空であってはならない- 戻り値:
- 最新のタスク実行または null
- 関連事項: