パッケージ org.springframework.boot.task

クラス TaskSchedulerBuilder

java.lang.ObjectSE
org.springframework.boot.task.TaskSchedulerBuilder
@DeprecatedSE(since="3.2.0", forRemoval=true) public class TaskSchedulerBuilder extends ObjectSE
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
3.2.0 以降、3.4.0 で削除され ThreadPoolTaskSchedulerBuilder を推奨
TaskScheduler の構成と作成に使用できるビルダー。一般的な ThreadPoolTaskScheduler 設定を設定するための便利なメソッドを提供します。高度な構成については、TaskSchedulerCustomizer の使用を検討してください。

典型的な自動構成 Spring Boot アプリケーションでは、このビルダーは Bean として利用でき、TaskScheduler が必要なときにいつでも注入できます。

導入:
2.1.0
作成者:
Stephane Nicoll

  • コンストラクターの詳細

    • TaskSchedulerBuilder

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

    • TaskSchedulerBuilder

      public TaskSchedulerBuilder(IntegerSE poolSize, BooleanSE awaitTermination, DurationSE awaitTerminationPeriod, StringSE threadNamePrefix, SetSE<TaskSchedulerCustomizer> taskSchedulerCustomizers)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  • メソッドの詳細

    • poolSize

      public TaskSchedulerBuilder poolSize(int poolSize)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      スレッドの最大許容数を設定します。
      パラメーター:
      poolSize - 設定するプールサイズ
      戻り値:
      新しいビルダーインスタンス

    • awaitTermination

      public TaskSchedulerBuilder awaitTermination(boolean awaitTermination)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      executor が、実行中のタスクを中断したり、キュー内のすべてのタスクを実行したりせずに、シャットダウン時にスケジュールされたタスクが完了するのを待つかどうかを設定します。
      パラメーター:
      awaitTermination - executor がシャットダウン時にタスクが完了するのを待つ必要があるかどうか
      戻り値:
      新しいビルダーインスタンス
      関連事項:

    • awaitTerminationPeriod

      public TaskSchedulerBuilder awaitTerminationPeriod(DurationSE awaitTerminationPeriod)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      シャットダウン時に executor がブロックする最大時間を設定します。設定すると、コンテナーの残りがシャットダウンを続ける前に、残りのタスクが実行を完了するのを待つために、executor はシャットダウン時にブロックします。これは、残りのタスクがコンテナーによって管理されている他のリソースへのアクセスを必要とする可能性がある場合に特に役立ちます。
      パラメーター:
      awaitTerminationPeriod - 設定する終了待ち期間
      戻り値:
      新しいビルダーインスタンス

    • threadNamePrefix

      public TaskSchedulerBuilder threadNamePrefix(StringSE threadNamePrefix)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      新しく作成されたスレッドの名前に使用する接頭辞を設定します。
      パラメーター:
      threadNamePrefix - 設定するスレッド名の接頭辞
      戻り値:
      新しいビルダーインスタンス

    • customizers

      public TaskSchedulerBuilder customizers(TaskSchedulerCustomizer... customizers)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      ThreadPoolTaskScheduler に適用する TaskSchedulerCustomizers を設定します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。この値を設定すると、以前に構成されたカスタマイザーが置き換えられます。
      パラメーター:
      customizers - 設定するカスタマイザー
      戻り値:
      新しいビルダーインスタンス
      関連事項:

    • customizers

      public TaskSchedulerBuilder customizers(IterableSE<TaskSchedulerCustomizer> customizers)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      ThreadPoolTaskScheduler に適用する taskSchedulerCustomizers を設定します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。この値を設定すると、以前に構成されたカスタマイザーが置き換えられます。
      パラメーター:
      customizers - 設定するカスタマイザー
      戻り値:
      新しいビルダーインスタンス
      関連事項:

    • additionalCustomizers

      public TaskSchedulerBuilder additionalCustomizers(TaskSchedulerCustomizer... customizers)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      ThreadPoolTaskScheduler に適用する必要がある taskSchedulerCustomizers を追加します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。
      パラメーター:
      customizers - 追加するカスタマイザー
      戻り値:
      新しいビルダーインスタンス
      関連事項:

    • additionalCustomizers

      public TaskSchedulerBuilder additionalCustomizers(IterableSE<TaskSchedulerCustomizer> customizers)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      ThreadPoolTaskScheduler に適用する必要がある taskSchedulerCustomizers を追加します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。
      パラメーター:
      customizers - 追加するカスタマイザー
      戻り値:
      新しいビルダーインスタンス
      関連事項:

    • build

      public ThreadPoolTaskScheduler build()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      新しい ThreadPoolTaskScheduler インスタンスをビルドし、このビルダーを使用して構成します。
      戻り値:
      構成済みの ThreadPoolTaskScheduler インスタンス。
      関連事項:

    • configure

      public <T extends ThreadPoolTaskScheduler> T configure(T taskScheduler)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      このビルダーを使用して、提供された ThreadPoolTaskScheduler インスタンスを構成します。
      型パラメーター:
      T - タスクスケジューラの種類
      パラメーター:
      taskScheduler - 構成する ThreadPoolTaskScheduler
      戻り値:
      タスクスケジューラインスタンス
      関連事項: