KafkaProducerMessageHandlerSpec (Spring Integration API)

java.lang.ObjectSE
- org.springframework.beans.factory.config.AbstractFactoryBean<T>
- - org.springframework.integration.dsl.IntegrationComponentSpec<S,H>
 - - org.springframework.integration.dsl.MessageHandlerSpec<S,KafkaProducerMessageHandler<K,V>>
 - - org.springframework.integration.kafka.dsl.KafkaProducerMessageHandlerSpec<K,V,S>

型パラメーター:
K - 鍵の型。
V - 値の型。
S - KafkaProducerMessageHandlerSpec 拡張型。
実装されているすべてのインターフェース:
Aware, BeanClassLoaderAware, BeanFactoryAware, DisposableBean, FactoryBean<KafkaProducerMessageHandler<K,V>>, InitializingBean, Lifecycle, Phased, SmartLifecycle
既知の直属サブクラス
KafkaOutboundGatewaySpec, KafkaProducerMessageHandlerSpec.KafkaProducerMessageHandlerTemplateSpec
```
public class KafkaProducerMessageHandlerSpec<K,V,S extends KafkaProducerMessageHandlerSpec<K,V,S>>
extends MessageHandlerSpec<S,KafkaProducerMessageHandler<K,V>>
```
KafkaProducerMessageHandler の MessageHandlerSpec 実装。
導入:
5.4
作成者:
Artem Bilan, Biju Kunjummen, Gary Russell

ネストされたクラスの要約

ネストされたクラス
修飾子と型	クラスと説明
`static class`	`KafkaProducerMessageHandlerSpec.KafkaProducerMessageHandlerTemplateSpec<K, V>` `KafkaTemplate` ベースの `KafkaProducerMessageHandlerSpec` 拡張。

フィールドのサマリー
- クラス org.springframework.integration.dsl.IntegrationComponentSpec から継承されたフィールド
  PARSER, target
- クラス org.springframework.beans.factory.config.AbstractFactoryBean から継承されたフィールド
  logger
- インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
  DEFAULT_PHASE
- インターフェース org.springframework.beans.factory.FactoryBean から継承されたフィールド
  OBJECT_TYPE_ATTRIBUTE

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`<P> S`	`flush(java.util.function.FunctionSE<Message<P>,BooleanSE> flushFunction)` 実行時に呼び出される `Function`SE を構成して、送信後にプロデューサーをフラッシュするかどうかを決定します。
`S`	`flushExpression(Expression flushExpression)` 送信後にプロデューサーをフラッシュするかどうかを決定するように `Expression` を構成します。
`S`	`flushExpression(StringSE flushExpression)` 送信後にプロデューサーをフラッシュするかどうかを決定するように SpEL 式を構成します。
`S`	`futuresChannel(MessageChannel futuresChannel)` 先物送信先のチャネルを設定します。
`S`	`futuresChannel(StringSE futuresChannel)` 先物送信先のチャネルを設定します。
`S`	`headerMapper(org.springframework.kafka.support.KafkaHeaderMapper mapper)` Spring メッセージングヘッダーを Kafka ヘッダーにマップするには、ヘッダーマッパーを指定します。
`<P> S`	`messageKey(java.util.function.FunctionSE<Message<P>,?> messageKeyFunction)` 実行時に呼び出される `Function`SE を構成して、メッセージがトピックに保管されるメッセージキーを決定します。
`S`	`messageKey(StringSE messageKey)` Kafka トピックにメッセージを格納するようにメッセージキーを設定します。
`S`	`messageKeyExpression(Expression messageKeyExpression)` 評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時に保存する Kafka メッセージキーを決定するように `Expression` を構成します。
`S`	`messageKeyExpression(StringSE messageKeyExpression)` SpEL 式を構成して、評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時に保存する Kafka メッセージキーを決定します。
`<P> S`	`partitionId(java.util.function.FunctionSE<Message<P>,IntegerSE> partitionIdFunction)` 実行時に呼び出される `Function`SE を構成して、メッセージがトピックに保管されるパーティション ID を判別します。
`S`	`partitionId(IntegerSE partitionId)` partitionId または Kafka トピックを構成します。
`S`	`partitionIdExpression(Expression partitionIdExpression)` 評価コンテキストのルートオブジェクトとして、リクエストメッセージに対して実行時にトピック partitionId を決定するように `Expression` を構成します。
`S`	`partitionIdExpression(StringSE partitionIdExpression)` 評価コンテキストのルートオブジェクトとして、リクエストメッセージに対して実行時にトピック partitionId を決定する SpEL 式を構成します。
`S`	`sendFailureChannel(MessageChannel sendFailureChannel)` 失敗した送信結果が送信されるチャネルを設定します。
`S`	`sendFailureChannel(StringSE sendFailureChannel)` 失敗した送信結果が送信されるチャネルを設定します。
`S`	`sendSuccessChannel(MessageChannel sendSuccessChannel)` 成功した送信結果が送信されるチャネルを設定します。
`S`	`sendSuccessChannel(StringSE sendSuccessChannel)` 成功した送信結果が送信されるチャネルを設定します。
`S`	`sendTimeout(long sendTimeout)` `KafkaProducerMessageHandler` が操作結果の送信を待機する時間をミリ秒単位で指定します。
`S`	`sync(boolean sync)` `KafkaProducerMessageHandler` が送信操作の結果を待機する必要があるかどうかを示す `boolean`。
`<P> S`	`timestamp(java.util.function.FunctionSE<Message<P>,LongSE> timestampFunction)` Kafka レコードのタイムスタンプがトピックに格納されることを決定するために実行時に呼び出される `Function`SE を構成します。
`S`	`timestampExpression(Expression timestampExpression)` 評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時にタイムスタンプを決定するように `Expression` を構成します。
`S`	`timestampExpression(StringSE timestampExpression)` 評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時にタイムスタンプを決定するように SpEL 式を構成します。
`<P> S`	`topic(java.util.function.FunctionSE<Message<P>,StringSE> topicFunction)` メッセージの送信先のトピックを決定するために実行時に呼び出される `Function`SE を構成します。
`S`	`topic(StringSE topic)` メッセージを送信するように Kafka トピックを構成します。
`S`	`topicExpression(Expression topicExpression)` 評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時に Kafka トピックを決定するように `Expression` を構成します。
`S`	`topicExpression(StringSE topicExpression)` 評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時に Kafka トピックを決定するように SpEL 式を構成します。

クラス org.springframework.integration.dsl.IntegrationComponentSpec から継承されたメソッド
_this, createInstance, destroyInstance, doGet, get, getId, getObjectType, getPhase, id, isAutoStartup, isRunning, start, stop, stop

クラス org.springframework.beans.factory.config.AbstractFactoryBean から継承されたメソッド
afterPropertiesSet, destroy, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- メソッドの詳細
 - topic
```
public S topic(StringSE topic)
```
 メッセージを送信するように Kafka トピックを構成します。
 パラメーター:
 topic - Kafka トピック名。
 戻り値:
 スペック。
 - topicExpression
```
public S topicExpression(StringSE topicExpression)
```
 評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時に Kafka トピックを決定するように SpEL 式を構成します。
 パラメーター:
 topicExpression - トピック SpEL 式。
 戻り値:
 スペック。
 - topicExpression
```
public S topicExpression(Expression topicExpression)
```
 評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時に Kafka トピックを決定するように Expression を構成します。
 パラメーター:
 topicExpression - トピック式。
 戻り値:
 スペック。
 - topic
```
public  S topic(java.util.function.FunctionSE<Message,StringSE> topicFunction)
```
 メッセージの送信先のトピックを決定するために実行時に呼び出される FunctionSE を構成します。通常、Java 8 ラムダ式で使用されます。
```
 .<Foo>topic(m -> m.getPayload().getTopic())
 
 
```
 型パラメーター:
 P - 予想されるペイロード型。
 パラメーター:
 topicFunction - トピック関数。
 戻り値:
 現在の KafkaProducerMessageHandlerSpec。
 関連事項:
 FunctionExpression
 - messageKeyExpression
```
public S messageKeyExpression(StringSE messageKeyExpression)
```
 SpEL 式を構成して、評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時に保存する Kafka メッセージキーを決定します。
 パラメーター:
 messageKeyExpression - メッセージキーの SpEL 式。
 戻り値:
 スペック。
 - messageKey
```
public S messageKey(StringSE messageKey)
```
 Kafka トピックにメッセージを格納するようにメッセージキーを設定します。
 パラメーター:
 messageKey - 使用するメッセージキー。
 戻り値:
 スペック。
 - messageKeyExpression
```
public S messageKeyExpression(Expression messageKeyExpression)
```
 評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時に保存する Kafka メッセージキーを決定するように Expression を構成します。
 パラメーター:
 messageKeyExpression - メッセージキー式。
 戻り値:
 スペック。
 - messageKey
```
public  S messageKey(java.util.function.FunctionSE<Message,?> messageKeyFunction)
```
 実行時に呼び出される FunctionSE を構成して、メッセージがトピックに保管されるメッセージキーを決定します。通常、Java 8 ラムダ式で使用されます。
```
 .<Foo>messageKey(m -> m.getPayload().getKey())
 
 
```
 型パラメーター:
 P - 予想されるペイロード型。
 パラメーター:
 messageKeyFunction - メッセージキー機能。
 戻り値:
 現在の KafkaProducerMessageHandlerSpec。
 関連事項:
 FunctionExpression
 - partitionId
```
public S partitionId(IntegerSE partitionId)
```
 partitionId または Kafka トピックを構成します。
 パラメーター:
 partitionId - 使用する partitionId。
 戻り値:
 スペック。
 - partitionIdExpression
```
public S partitionIdExpression(StringSE partitionIdExpression)
```
 評価コンテキストのルートオブジェクトとして、リクエストメッセージに対して実行時にトピック partitionId を決定する SpEL 式を構成します。
 パラメーター:
 partitionIdExpression - 使用する partitionId 式。
 戻り値:
 スペック。
 - partitionId
```
public  S partitionId(java.util.function.FunctionSE<Message,IntegerSE> partitionIdFunction)
```
 実行時に呼び出される FunctionSE を構成して、メッセージがトピックに保管されるパーティション ID を判別します。通常、Java 8 ラムダ式で使用されます。
```
 .partitionId(m -> m.getHeaders().get("partitionId", Integer.class))
 
 
```
 型パラメーター:
 P - 予想されるペイロード型。
 パラメーター:
 partitionIdFunction - partitionId 関数。
 戻り値:
 スペック。
 - partitionIdExpression
```
public S partitionIdExpression(Expression partitionIdExpression)
```
 評価コンテキストのルートオブジェクトとして、リクエストメッセージに対して実行時にトピック partitionId を決定するように Expression を構成します。
 パラメーター:
 partitionIdExpression - 使用する partitionId 式。
 戻り値:
 スペック。
 - timestampExpression
```
public S timestampExpression(StringSE timestampExpression)
```
 評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時にタイムスタンプを決定するように SpEL 式を構成します。
 パラメーター:
 timestampExpression - 使用するタイムスタンプ式。
 戻り値:
 スペック。
 - timestamp
```
public  S timestamp(java.util.function.FunctionSE<Message,LongSE> timestampFunction)
```
 Kafka レコードのタイムスタンプがトピックに格納されることを決定するために実行時に呼び出される FunctionSE を構成します。通常、Java 8 ラムダ式で使用されます。
```
 .timestamp(m -> m.getHeaders().get("mytimestamp_header", Long.class))
 
 
```
 型パラメーター:
 P - 予想されるペイロード型。
 パラメーター:
 timestampFunction - タイムスタンプ関数。
 戻り値:
 スペック。
 - timestampExpression
```
public S timestampExpression(Expression timestampExpression)
```
 評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時にタイムスタンプを決定するように Expression を構成します。
 パラメーター:
 timestampExpression - 使用するタイムスタンプ式。
 戻り値:
 スペック。
 - flushExpression
```
public S flushExpression(StringSE flushExpression)
```
 送信後にプロデューサーをフラッシュするかどうかを決定するように SpEL 式を構成します。デフォルトでは、ヘッダー kafka_flush の値が Boolean.TRUESE の場合、プロデューサーはフラッシュされます。
 パラメーター:
 flushExpression - 使用するタイムスタンプ式。
 戻り値:
 スペック。
 - flush
```
public  S flush(java.util.function.FunctionSE<Message,BooleanSE> flushFunction)
```
 実行時に呼び出される FunctionSE を構成して、送信後にプロデューサーをフラッシュするかどうかを決定します。デフォルトでは、ヘッダー kafka_flush の値が Boolean.TRUESE の場合、プロデューサーはフラッシュされます。通常、Java 8 ラムダ式で使用されます。
```
 .flush(m -> m.getPayload().shouldFlush())
 
 
```
 型パラメーター:
 P - 予想されるペイロード型。
 パラメーター:
 flushFunction - フラッシュ機能。
 戻り値:
 スペック。
 - flushExpression
```
public S flushExpression(Expression flushExpression)
```
 送信後にプロデューサーをフラッシュするかどうかを決定するように Expression を構成します。デフォルトでは、ヘッダー kafka_flush の値が Boolean.TRUESE の場合、プロデューサーはフラッシュされます。
 パラメーター:
 flushExpression - 使用するタイムスタンプ式。
 戻り値:
 スペック。
 - sync
```
public S sync(boolean sync)
```
 KafkaProducerMessageHandler が送信操作の結果を待機する必要があるかどうかを示す boolean。デフォルトは false です。sync モードでは、ダウンストリーム送信操作の例外が再スローされます。
 パラメーター:
 sync - 送信モード。デフォルトでは非同期です。
 戻り値:
 スペック。
 - sendTimeout
```
public S sendTimeout(long sendTimeout)
```
 KafkaProducerMessageHandler が操作結果の送信を待機する時間をミリ秒単位で指定します。デフォルトは 10 秒です。
 パラメーター:
 sendTimeout - 送信操作の結果を待機するためのタイムアウト。
 戻り値:
 スペック。
 - headerMapper
```
public S headerMapper(org.springframework.kafka.support.KafkaHeaderMapper mapper)
```
 Spring メッセージングヘッダーを Kafka ヘッダーにマップするには、ヘッダーマッパーを指定します。
 パラメーター:
 mapper - マッパー。
 戻り値:
 スペック。
 - sendSuccessChannel
```
public S sendSuccessChannel(MessageChannel sendSuccessChannel)
```
 成功した送信結果が送信されるチャネルを設定します。
 パラメーター:
 sendSuccessChannel - チャンネル。
 戻り値:
 スペック。
 導入:
 3.0.2
 - sendSuccessChannel
```
public S sendSuccessChannel(StringSE sendSuccessChannel)
```
 成功した送信結果が送信されるチャネルを設定します。
 パラメーター:
 sendSuccessChannel - チャンネル名。
 戻り値:
 スペック。
 導入:
 3.0.2
 - sendFailureChannel
```
public S sendFailureChannel(MessageChannel sendFailureChannel)
```
 失敗した送信結果が送信されるチャネルを設定します。
 パラメーター:
 sendFailureChannel - チャンネル。
 戻り値:
 スペック。
 導入:
 3.0.2
 - sendFailureChannel
```
public S sendFailureChannel(StringSE sendFailureChannel)
```
 失敗した送信結果が送信されるチャネルを設定します。
 パラメーター:
 sendFailureChannel - チャンネル名。
 戻り値:
 スペック。
 導入:
 3.0.2
 - futuresChannel
```
public S futuresChannel(MessageChannel futuresChannel)
```
 先物送信先のチャネルを設定します。
 パラメーター:
 futuresChannel - チャンネル。
 戻り値:
 スペック。
 導入:
 5.4
 - futuresChannel
```
public S futuresChannel(StringSE futuresChannel)
```
 先物送信先のチャネルを設定します。
 パラメーター:
 futuresChannel - チャンネル名。
 戻り値:
 スペック。
 導入:
 5.4

クラス KafkaProducerMessageHandlerSpec<K,V,S extends KafkaProducerMessageHandlerSpec<K,V,S>>

ネストされたクラスの要約

フィールドのサマリー

クラス org.springframework.integration.dsl.IntegrationComponentSpec から継承されたフィールド

クラス org.springframework.beans.factory.config.AbstractFactoryBean から継承されたフィールド

インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド

インターフェース org.springframework.beans.factory.FactoryBean から継承されたフィールド

メソッドのサマリー

クラス org.springframework.integration.dsl.IntegrationComponentSpec から継承されたメソッド

クラス org.springframework.beans.factory.config.AbstractFactoryBean から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

メソッドの詳細

topic

topicExpression

topicExpression

topic

messageKeyExpression

messageKey

messageKeyExpression

messageKey

partitionId

partitionIdExpression

partitionId

partitionIdExpression

timestampExpression

timestamp

timestampExpression

flushExpression

flush

flushExpression

sync

sendTimeout

headerMapper

sendSuccessChannel

sendSuccessChannel

sendFailureChannel

sendFailureChannel

futuresChannel

futuresChannel