インターフェース JobOperator

メソッドの詳細

• getExecutions

  ListSE<LongSE> getExecutions(long instanceId) throws NoSuchJobInstanceException

  特定の JobInstance に関連付けられた JobExecutions を、作成順（したがって、通常は実行順）でリストします。

  パラメーター:

  instanceId - JobInstance の ID

  戻り値:

  このインスタンスに関連付けられているすべての JobExecutions の ID 値

  例外:

  NoSuchJobInstanceException - instanceId に関連付けられた JobInstance が見つからない場合。

• getJobInstances

  ListSE<LongSE> getJobInstances(StringSE jobName, int start, int count) throws NoSuchJobException

  指定されたジョブ名の JobInstances を、作成とは逆の順序で（したがって、通常は最初に実行されたときに）リストします。

  パラメーター:

  jobName - すべてのインスタンスが持つジョブ名

  start - インスタンスの開始インデックス

  count - 返す値の最大数

  戻り値:

  JobInstances の ID 値

  例外:

  NoSuchJobException - jobName の JobInstance が存在しない場合にスローされます。

• getJobInstance

  @Nullable default JobInstance getJobInstance(StringSE jobName, JobParameters jobParameters)

  パラメーター:

  jobName - StringSE ジョブの名前。

  jobParameters - ジョブインスタンスの JobParameters パラメーター。

  戻り値:

  指定された名前とパラメーターを持つ JobInstance、または null。

  導入:

  5.0

• getRunningExecutions

  SetSE<LongSE> getRunningExecutions(StringSE jobName) throws NoSuchJobException

  指定されたジョブ名で実行中のすべての JobExecutions の ID 値を取得します。

  パラメーター:

  jobName - 検索するジョブの名前

  戻り値:

  実行中の JobExecution インスタンスの ID 値

  例外:

  NoSuchJobException - そのジョブ名を持つ JobExecutions がない場合

• getParameters

  StringSE getParameters(long executionId) throws NoSuchJobExecutionException

  人間が読める文字列として JobParameters を取得します (改行で区切られたキー = 値のペア)。

  パラメーター:

  executionId - 既存の JobExecution の ID

  戻り値:

  関連するインスタンスを起動するために使用されたジョブパラメーター

  例外:

  NoSuchJobExecutionException - ID が JobExecution に関連付けられていなかった場合

• start

  @DeprecatedSE(since="5.0.1", forRemoval=true) LongSE start(StringSE jobName, StringSE parameters) throws NoSuchJobException, JobInstanceAlreadyExistsException, JobParametersInvalidException

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  代わりに start(String, Properties) を使用してください。v5.2 で削除されます。

  指定されたパラメーターを使用して、ジョブの新しいインスタンスを開始します。

  パラメーター:

  jobName - 起動する Job の名前

  parameters - 起動するためのパラメーター (改行で区切られたキー = 値のペア)

  戻り値:

  起動された JobExecution の ID

  例外:

  NoSuchJobException - 指定された名前の Job がない場合

  JobInstanceAlreadyExistsException - この名前とパラメーターのジョブインスタンスがすでに存在する場合

  JobParametersInvalidException - ジョブパラメーターのいずれかが無効な場合にスローされます。

• start

  default LongSE start(StringSE jobName, PropertiesSE parameters) throws NoSuchJobException, JobInstanceAlreadyExistsException, JobParametersInvalidException

  指定されたパラメーターを使用して、ジョブの新しいインスタンスを開始します。

  パラメーター:

  jobName - 起動する Job の名前

  parameters - 起動するためのパラメーター

  戻り値:

  起動された JobExecution の ID

  例外:

  NoSuchJobException - 指定された名前の Job がない場合

  JobInstanceAlreadyExistsException - この名前とパラメーターのジョブインスタンスがすでに存在する場合

  JobParametersInvalidException - ジョブパラメーターのいずれかが無効な場合にスローされます。

• restart

  LongSE restart(long executionId) throws JobInstanceAlreadyCompleteException, NoSuchJobExecutionException, NoSuchJobException, JobRestartException, JobParametersInvalidException

  失敗または停止した JobExecution を再起動します。指定された ID が存在しないか、通常の状況ですでに正常に完了した JobInstance に対応する場合、例外で失敗します。

  パラメーター:

  executionId - 失敗または停止した JobExecution の ID

  戻り値:

  開始された JobExecution の ID

  例外:

  JobInstanceAlreadyCompleteException - ジョブがすでに正常に完了した場合

  NoSuchJobExecutionException - ID が JobExecution に関連付けられていなかった場合

  NoSuchJobException - JobExecution は見つかったが、対応する Job が起動に使用できなくなった場合

  JobRestartException - 再起動時に特定できないエラーが発生した場合 (たとえば破損または一貫性のない再起動データ)

  JobParametersInvalidException - パラメーターがこのジョブに有効でない場合

• startNextInstance

  LongSE startNextInstance(StringSE jobName) throws NoSuchJobException, JobParametersNotFoundException, JobRestartException, JobExecutionAlreadyRunningException, JobInstanceAlreadyCompleteException, UnexpectedJobExecutionException, JobParametersInvalidException

  指定されたジョブに接続された JobParametersIncrementer によって決定される JobInstance のシーケンスで次を起動します。前のインスタンスがまだ障害状態にある場合、このメソッドは新しいインスタンスを作成し、（JobParametersIncrementer が機能している限り）異なるパラメーターで実行する必要があります。
  
  以下で説明する最後の 3 つの例外は非常に起こりそうにありませんが、完全に除外することはできません。同時にこのメソッド（または類似のメソッド）を使用しようとしている他のスレッドまたはプロセスを指します。

  パラメーター:

  jobName - 起動するジョブの名前

  戻り値:

  ジョブの起動時に作成された実行の JobExecution ID

  例外:

  NoSuchJobException - 利用可能なそのようなジョブ定義がない場合

  JobParametersNotFoundException - パラメーターが見つからない場合

  JobParametersInvalidException - ジョブパラメーターの一部が無効な場合にスローされます。

  UnexpectedJobExecutionException - 予期しない状況が発生した場合

  JobRestartException - ジョブが不正に再起動された場合にスローされます。

  JobExecutionAlreadyRunningException - すでに実行中のジョブを再開しようとするとスローされます。

  JobInstanceAlreadyCompleteException - 完了したジョブを再開しようとするとスローされます。

• stop

  boolean stop(long executionId) throws NoSuchJobExecutionException, JobExecutionNotRunningException

  指定された ID を使用して JobExecution に停止信号を送信します。このメソッドが true を返した場合、シグナルは正常に送信されますが、ジョブが停止したことを意味するわけではありません。それを確認する唯一の方法は、ジョブの実行ステータスをポーリングすることです。

  パラメーター:

  executionId - 実行中の JobExecution の ID

  戻り値:

  メッセージが正常に送信された場合は true (ジョブが停止したことを保証しません)

  例外:

  NoSuchJobExecutionException - 指定された ID を持つ JobExecution がない場合

  JobExecutionNotRunningException - JobExecution が実行されていない場合 (止められない)

• getSummary

  StringSE getSummary(long executionId) throws NoSuchJobExecutionException

  提供された ID で JobExecution を要約し、ステータス、開始時間と終了時間などの詳細を示します。

  パラメーター:

  executionId - 既存の JobExecution の ID

  戻り値:

  ジョブ実行の状態を要約した文字列

  例外:

  NoSuchJobExecutionException - 指定された ID の JobExecution がない場合

• getStepExecutionSummaries

  MapSE<LongSE,StringSE> getStepExecutionSummaries(long executionId) throws NoSuchJobExecutionException

  JobExecution に属する StepExecution インスタンスを、指定された ID で要約し、ステータス、開始時刻、終了時刻などの詳細を示します。

  パラメーター:

  executionId - 既存の JobExecution の ID

  戻り値:

  ステップ実行 ID と文字列へのマップで、実行の状態を要約したもの

  例外:

  NoSuchJobExecutionException - 指定された ID の JobExecution がない場合

• getJobNames

  SetSE<StringSE> getJobNames()

  start(String, Properties) で起動できる使用可能なジョブ名をリストします。

  戻り値:

  ジョブ名のセット

• abandon

  JobExecution abandon(long jobExecutionId) throws NoSuchJobExecutionException, JobExecutionAlreadyRunningException

  JobExecution を ABANDONED としてマークします。プロセスが停止したために停止信号が無視された場合、これは（STOPPED とは対照的に）ジョブを終了済みとしてマークする最良の方法です。破棄されたジョブの実行は、フレームワークによって再開できません。

  パラメーター:

  jobExecutionId - 中止するジョブ実行 ID

  戻り値:

  中止された JobExecution

  例外:

  NoSuchJobExecutionException - jobExecutionId のジョブ実行がない場合にスローされます。

  JobExecutionAlreadyRunningException - ジョブが実行中の場合 (最初に停止する必要があります)