クラス RetryTopicConfigurationBuilder
java.lang.ObjectSE
org.springframework.kafka.retrytopic.RetryTopicConfigurationBuilder
RetryTopicConfiguration
インスタンスを作成するためのビルダークラス。- 導入:
- 2.7
- 作成者:
- Tomaz Fernandes, Gary Russell, Adrian Chlebosz, Wang Zhiyang
コンストラクターのサマリー
コンストラクターメソッドのサマリー
修飾子と型メソッド説明autoCreateTopics
(BooleanSE shouldCreate, IntegerSE numPartitions, ShortSE replicationFactor) オプションで、提供されたプロパティを使用してトピックを作成するようにトピック作成動作を構成します。autoCreateTopicsWith
(IntegerSE numPartitions, ShortSE replicationFactor) 指定されたプロパティでトピックを自動作成するようにトピック作成動作を構成します。autoStartDltHandler
(BooleanSE autoStart) DLT ハンドラー(構成済みまたはデフォルト)を開始しない場合は、false に設定します。コンテナーファクトリの autoStartup プロパティを上書きします。concurrency
(IntegerSE concurrency) 再試行コンテナーと DLT コンテナーの同時実行を構成します。create
(KafkaOperations<?, ?> sendToTopicKafkaTemplate) 提供されたテンプレートを使用してRetryTopicConfiguration
を作成します。customBackoff
(org.springframework.retry.backoff.SleepingBackOffPolicy<?> backOffPolicy) カスタムSleepingBackOffPolicy
を構成します。dltHandlerMethod
(StringSE beanName, StringSE methodName) DLT ハンドラーメソッドを設定します。dltHandlerMethod
(EndpointHandlerMethod endpointHandlerMethod) DLT ハンドラーメソッドを設定します。dltProcessingFailureStrategy
(DltStrategy dltStrategy) DltStrategy
を構成します。dltRoutingRules
(MapSE<StringSE, SetSE<ClassSE<? extends ThrowableSE>>> dltRoutingRules) メッセージ処理中に構成された例外がスローされた場合に、メッセージがカスタム DLT にリダイレクトされるように DLT ルーティングルールを設定するように構成します。DLT トピックに追加するサフィックスを構成します。トピックを自動作成しないようにトピック作成動作を構成します。DltStrategy
をDltStrategy.NO_DLT
に構成します。DltStrategy
をDltStrategy.FAIL_ON_ERROR
に構成します。excludeTopic
(StringSE topicName) ターゲット構成が使用されないトピック名を構成します。excludeTopics
(ListSE<StringSE> topicNames) ターゲット構成が使用されないトピック名を構成します。exponentialBackoff
(long initialInterval, double multiplier, long maxInterval) ExponentialBackOffPolicy
を構成します。exponentialBackoff
(long initialInterval, double multiplier, long maxInterval, boolean withRandom) ランダムパラメーターに応じて、ExponentialBackOffPolicy
またはExponentialRandomBackOffPolicy
を設定します。fixedBackOff
(int interval) FixedBackOffPolicy
を構成します。fixedBackOff
(long interval) FixedBackOffPolicy
を構成します。includeTopic
(StringSE topicName) ターゲット構成を使用するトピック名を構成します。includeTopics
(ListSE<StringSE> topicNames) ターゲット構成を使用するトピック名を構成します。listenerFactory
(StringSE factoryBeanName) Bean 名を介して使用するコンテナーファクトリを構成します。listenerFactory
(ConcurrentKafkaListenerContainerFactory<?, ?> factory) 使用するコンテナーファクトリを構成します。maxAttempts
(int maxAttempts) 配信の最大試行回数 (初回を含む) を構成します。ビルダーの新しいインスタンスを作成します。NoBackOffPolicy
を構成します。notRetryOn
(ClassSE<? extends ThrowableSE> throwable) 提供されたThrowable
SE で再試行しないように動作を構成します。notRetryOn
(ListSE<ClassSE<? extends ThrowableSE>> throwables) 提供されたThrowable
SE で再試行しないように動作を構成します。retryOn
(ClassSE<? extends ThrowableSE> throwable) 提供されたThrowable
SE で再試行するように動作を構成します。retryOn
(ListSE<ClassSE<? extends ThrowableSE>> throwables) 提供されたThrowable
SE で再試行するように動作を構成します。retryTopicSuffix
(StringSE suffix) 再試行トピックに追加するサフィックスを構成します。sameIntervalTopicReuseStrategy
(SameIntervalTopicReuseStrategy sameIntervalTopicReuseStrategy) SameIntervalTopicReuseStrategy
を構成します。setTopicSuffixingStrategy
(TopicSuffixingStrategy topicSuffixingStrategy) 再試行トピック名TopicSuffixingStrategy
を構成します。再試行トピック名の末尾に序数のインデックス値を付けるように構成します。timeoutAfter
(long timeout) ミリ秒単位でグローバルタイムアウトを構成します。その後、リスナーが次に例外をスローしたときにレコードが DLT に直接送信されます。原因 チェーン をトラバースするように分類子を構成します。traversingCauses
(boolean traversing) 原因 チェーン をトラバースするか、トラバースしないように分類子を構成します。uniformRandomBackoff
(long minInterval, long maxInterval) UniformRandomBackOffPolicy
を構成します。同じバックオフ間隔の試行に対して単一の再試行トピックの使用を構成します (これらの試行が チェーン の最後にある限り)。
コンストラクターの詳細
RetryTopicConfigurationBuilder
public RetryTopicConfigurationBuilder()
メソッドの詳細
dltHandlerMethod
DLT ハンドラーメソッドを設定します。- パラメーター:
beanName
- Bean 名。methodName
- メソッド名。- 戻り値:
- ビルダー。
- 導入:
- 2.8
concurrency
再試行コンテナーと DLT コンテナーの同時実行を構成します。- パラメーター:
concurrency
- 並行性。- 戻り値:
- ビルダー。
- 導入:
- 3.0
dltHandlerMethod
DLT ハンドラーメソッドを設定します。- パラメーター:
endpointHandlerMethod
- ハンドラーメソッド。- 戻り値:
- ビルダー。
doNotRetryOnDltFailure
DltStrategy
をDltStrategy.FAIL_ON_ERROR
に構成します。- 戻り値:
- ビルダー。
dltProcessingFailureStrategy
DltStrategy
を構成します。- パラメーター:
dltStrategy
- 戦略。- 戻り値:
- ビルダー。
doNotConfigureDlt
DltStrategy
をDltStrategy.NO_DLT
に構成します。- 戻り値:
- ビルダー。
autoStartDltHandler
DLT ハンドラー(構成済みまたはデフォルト)を開始しない場合は、false に設定します。コンテナーファクトリの autoStartup プロパティを上書きします。- パラメーター:
autoStart
- 自動起動しない場合は false。- 戻り値:
- このビルダー。
- 導入:
- 2.8
includeTopics
ターゲット構成を使用するトピック名を構成します。- パラメーター:
topicNames
- 名。- 戻り値:
- ビルダー。
excludeTopics
ターゲット構成が使用されないトピック名を構成します。- パラメーター:
topicNames
- 名。- 戻り値:
- ビルダー。
includeTopic
ターゲット構成を使用するトピック名を構成します。- パラメーター:
topicName
- 名前。- 戻り値:
- ビルダー。
excludeTopic
ターゲット構成が使用されないトピック名を構成します。- パラメーター:
topicName
- 名前。- 戻り値:
- ビルダー。
retryTopicSuffix
再試行トピックに追加するサフィックスを構成します。- パラメーター:
suffix
- 接尾辞。- 戻り値:
- ビルダー。
dltSuffix
DLT トピックに追加するサフィックスを構成します。- パラメーター:
suffix
- 接尾辞。- 戻り値:
- ビルダー。
suffixTopicsWithIndexValues
再試行トピック名の末尾に序数のインデックス値を付けるように構成します。- 戻り値:
- ビルダー。
- 関連事項:
setTopicSuffixingStrategy
public RetryTopicConfigurationBuilder setTopicSuffixingStrategy(TopicSuffixingStrategy topicSuffixingStrategy) 再試行トピック名TopicSuffixingStrategy
を構成します。- パラメーター:
topicSuffixingStrategy
- 戦略。- 戻り値:
- ビルダー。
sameIntervalTopicReuseStrategy
public RetryTopicConfigurationBuilder sameIntervalTopicReuseStrategy(SameIntervalTopicReuseStrategy sameIntervalTopicReuseStrategy) SameIntervalTopicReuseStrategy
を構成します。メモ: 固定バックオフの場合、これが
SameIntervalTopicReuseStrategy.SINGLE_TOPIC
として構成されている場合、useSingleTopicForSameIntervals()
を介して行われた構成よりも優先されます。- パラメーター:
sameIntervalTopicReuseStrategy
- 戦略。- 戻り値:
- ビルダー。
- 導入:
- 3.0.4
useSingleTopicForSameIntervals
同じバックオフ間隔を持つ試行に対して単一の再試行トピックの使用を構成します (これらの試行が チェーン の最後にある限り)。指数バックオフ (maxDelay
が提供されている場合) の最後の再試行に使用され、固定バックオフに単一の再試行トピックを使用します。- 戻り値:
- ビルダー。
- 導入:
- 3.0.4
- 関連事項:
maxAttempts
配信の最大試行回数 (初回を含む) を構成します。- パラメーター:
maxAttempts
- 試み。- 戻り値:
- ビルダー。
timeoutAfter
ミリ秒単位でグローバルタイムアウトを構成します。その後、リスナーが次に例外をスローしたときにレコードが DLT に直接送信されます。デフォルトのタイムアウトなし。- パラメーター:
timeout
- タイムアウト。- 戻り値:
- ビルダー。
exponentialBackoff
public RetryTopicConfigurationBuilder exponentialBackoff(long initialInterval, double multiplier, long maxInterval) ExponentialBackOffPolicy
を構成します。- パラメーター:
initialInterval
- 初期遅延間隔。multiplier
- 乗数。maxInterval
- 最大遅延間隔。- 戻り値:
- ビルダー。
exponentialBackoff
public RetryTopicConfigurationBuilder exponentialBackoff(long initialInterval, double multiplier, long maxInterval, boolean withRandom) ランダムパラメーターに応じて、ExponentialBackOffPolicy
またはExponentialRandomBackOffPolicy
を設定します。- パラメーター:
initialInterval
- 初期遅延間隔。multiplier
- 乗数。maxInterval
- 最大遅延間隔。withRandom
-ExponentialRandomBackOffPolicy
の場合は true。- 戻り値:
- ビルダー。
fixedBackOff
FixedBackOffPolicy
を構成します。- パラメーター:
interval
- 間隔。- 戻り値:
- ビルダー。
uniformRandomBackoff
UniformRandomBackOffPolicy
を構成します。- パラメーター:
minInterval
- 最小間隔。maxInterval
- 最大間隔。- 戻り値:
- ビルダー。
noBackoff
NoBackOffPolicy
を構成します。- 戻り値:
- ビルダー。
customBackoff
public RetryTopicConfigurationBuilder customBackoff(org.springframework.retry.backoff.SleepingBackOffPolicy<?> backOffPolicy) カスタムSleepingBackOffPolicy
を構成します。- パラメーター:
backOffPolicy
- ポリシー。- 戻り値:
- ビルダー。
fixedBackOff
FixedBackOffPolicy
を構成します。- パラメーター:
interval
- 間隔。- 戻り値:
- ビルダー。
doNotAutoCreateRetryTopics
トピックを自動作成しないようにトピック作成動作を構成します。- 戻り値:
- ビルダー。
autoCreateTopicsWith
public RetryTopicConfigurationBuilder autoCreateTopicsWith(@Nullable IntegerSE numPartitions, @Nullable ShortSE replicationFactor) 指定されたプロパティでトピックを自動作成するようにトピック作成動作を構成します。- パラメーター:
numPartitions
- パーティションの数。replicationFactor
- 複製係数 (ブローカーがバージョン 2.4 以降の場合、ブローカーのデフォルトを使用するには -1)。- 戻り値:
- ビルダー。
autoCreateTopics
public RetryTopicConfigurationBuilder autoCreateTopics(@Nullable BooleanSE shouldCreate, @Nullable IntegerSE numPartitions, @Nullable ShortSE replicationFactor) オプションで、提供されたプロパティを使用してトピックを作成するようにトピック作成動作を構成します。- パラメーター:
shouldCreate
- 自動作成する場合は true。numPartitions
- パーティションの数。replicationFactor
- 複製係数 (ブローカーがバージョン 2.4 以降の場合、ブローカーのデフォルトを使用するには -1)。- 戻り値:
- ビルダー。
retryOn
提供されたThrowable
SE で再試行するように動作を構成します。- パラメーター:
throwable
- スローアブル。- 戻り値:
- ビルダー。
notRetryOn
提供されたThrowable
SE で再試行しないように動作を構成します。- パラメーター:
throwable
- スローアブル。- 戻り値:
- ビルダー。
retryOn
提供されたThrowable
SE で再試行するように動作を構成します。- パラメーター:
throwables
- 投げ物。- 戻り値:
- ビルダー。
notRetryOn
提供されたThrowable
SE で再試行しないように動作を構成します。- パラメーター:
throwables
- 投げ物。- 戻り値:
- ビルダー。
traversingCauses
原因 チェーン をトラバースするように分類子を構成します。- 戻り値:
- ビルダー。
traversingCauses
原因 チェーン をトラバースするか、トラバースしないように分類子を構成します。- パラメーター:
traversing
- トラバースするのは true です。- 戻り値:
- ビルダー。
dltRoutingRules
public RetryTopicConfigurationBuilder dltRoutingRules(MapSE<StringSE, SetSE<ClassSE<? extends ThrowableSE>>> dltRoutingRules) メッセージ処理中に構成された例外がスローされた場合に、メッセージをカスタム DLT にリダイレクトする DLT ルーティングルールを設定するように構成します。構成された例外との一致を見つけるために、最初にスローされた例外の原因が調べられます。- パラメーター:
dltRoutingRules
- カスタム DLT 名拡張子とそれに一致する例外の仕様- 戻り値:
- ビルダー
- 導入:
- 3.2.0
listenerFactory
public RetryTopicConfigurationBuilder listenerFactory(ConcurrentKafkaListenerContainerFactory<?, ?> factory) 使用するコンテナーファクトリを構成します。- パラメーター:
factory
- ファクトリ。- 戻り値:
- ビルダー。
listenerFactory
Bean 名を介して使用するコンテナーファクトリを構成します。- パラメーター:
factoryBeanName
- ファクトリ Bean 名。- 戻り値:
- ビルダー。
create
提供されたテンプレートを使用してRetryTopicConfiguration
を作成します。- パラメーター:
sendToTopicKafkaTemplate
- テンプレート。- 戻り値:
- 構成。
newInstance
ビルダーの新しいインスタンスを作成します。- 戻り値:
- 新しいインスタンス。