クラス ConsumerProperties

java.lang.ObjectSE
org.springframework.kafka.listener.ConsumerProperties
既知の直属サブクラス
ContainerProperties

public class ConsumerProperties extends ObjectSE
一般的なコンシューマープロパティ。
導入:
2.3
作成者:
Gary Russell
  • フィールドサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    static final long
    デフォルトの pollTimeout(ミリ秒)。
  • コンストラクターのサマリー

    コンストラクター
    コンストラクター
    説明
    指定されたトピックをサブスクライブするコンテナーのプロパティを作成します。
    指定されたパターンに一致するトピックをサブスクライブするコンテナーのプロパティを作成します。
    提供されたトピックパーティションを自分自身に割り当てるコンテナーのプロパティを作成します。
  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    認証 / 認可の再試行間隔を取得します。
    クライアント ID を返します。
    org.apache.kafka.clients.consumer.OffsetCommitCallback
    コミットコールバックを返します。
    オフセットコミットをログに記録するレベル。
    int
    true に設定された setSyncCommits(boolean) を使用しているときに、コンシューマーによって RetriableCommitFailedException がスローされたときに許可される再試行の回数。
    org.apache.kafka.clients.consumer.ConsumerRebalanceListener
    リバランスリスナーを返します。
    コンテナーのグループ ID を返します。
    コンシューマーファクトリによって提供されるコンシューマープロパティとマージされるコンシューマープロパティを取得します。ここのプロパティは、コンシューマーファクトリの同じ名前のプロパティよりも優先されます。
    オフセットおよびメタデータプロバイダーを返します。
    long
    同期コミットタイムアウトを返します。
    構成済みの TopicPartitionOffset を返します。
    構成されたトピックパターンを返します。
    構成されたトピックを返します。
    boolean
    null キーを使用した逆直列化例外ヘッダーを常に確認してください。
    boolean
    null 値の逆直列化例外ヘッダーを常に確認してください。
    boolean
    最終的なトランザクションオフセットを修正するかどうか。
    boolean
    protected final StringSE
    void
    setAuthExceptionRetryInterval(DurationSE authExceptionRetryInterval)
    AuthenticationException または org.apache.kafka.common.errors.AuthorizationException が KafkaConsumer によってスローされた後の再試行の間隔を設定します。
    void
    setCheckDeserExWhenKeyNull(boolean checkDeserExWhenKeyNull)
    null キーを受信したときに、常に DeserializationException ヘッダーをチェックするには、true に設定します。
    void
    setCheckDeserExWhenValueNull(boolean checkDeserExWhenValueNull)
    null 値を受け取ったときに、常に DeserializationException ヘッダーをチェックするには、true に設定します。
    void
    クライアント ID を設定します。コンシューマーファクトリの client.id プロパティを上書きします。
    void
    setCommitCallback(org.apache.kafka.clients.consumer.OffsetCommitCallback commitCallback)
    コミットコールバックを設定します。デフォルトでは、単純なロギングコールバックを使用して、DEBUG レベルでの成功と ERROR レベルでの失敗をログに記録します。
    void
    オフセットコミットをログに記録するレベルを設定します。
    void
    setCommitRetries(int commitRetries)
    true に設定された setSyncCommits(boolean) を使用しているときに、コンシューマーによって RetriableCommitFailedException がスローされたときに許可される再試行回数を設定します。
    void
    setConsumerRebalanceListener(org.apache.kafka.clients.consumer.ConsumerRebalanceListener consumerRebalanceListener)
    ユーザー定義の ConsumerRebalanceListener 実装を設定します。
    void
    setFixTxOffsets(boolean fixTxOffsets)
    トランザクションプロデューサーによって生成されたレコードを消費するときに、コンシューマーがパーティションの最後に配置されていると、トランザクションのコミット / ロールバックを示すために使用される疑似レコードや、ロールバックされたレコードが存在する可能性があるために、ラグが誤ってゼロよりも大きく報告されることがありました。
    void
    このコンテナーのグループ ID を設定します。
    void
    setKafkaConsumerProperties(PropertiesSE kafkaConsumerProperties)
    コンシューマーファクトリによって提供されるコンシューマープロパティとマージされるコンシューマープロパティを設定します。ここのプロパティは、コンシューマーファクトリの同じ名前のプロパティよりも優先されます。
    void
    コミットコールバックに関連付けられたオフセットおよびメタデータプロバイダーを設定します。
    void
    setPollTimeout(long pollTimeout)
    レコードを待機しているコンシューマーでブロックする最大時間を設定します。
    void
    setSyncCommits(boolean syncCommits)
    コンテナーがコミットを担当するときに consumer.commitSync() または commitAsync() を呼び出すかどうかを設定します。
    void
    setSyncCommitTimeout(DurationSE syncCommitTimeout)
    commitSync 操作のタイムアウトを設定します(isSyncCommits() の場合)。

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

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, wait, waitSE, waitSE
  • フィールドの詳細

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

    • ConsumerProperties

      public ConsumerProperties(StringSE... topics)
      指定されたトピックをサブスクライブするコンテナーのプロパティを作成します。
      パラメーター:
      topics - トピック。
    • ConsumerProperties

      public ConsumerProperties(PatternSE topicPattern)
      指定されたパターンに一致するトピックをサブスクライブするコンテナーのプロパティを作成します。フレームワークは、指定されたパターンに一致するすべてのトピックにサブスクライブするコンテナーを作成して、動的に割り当てられたパーティションを取得します。チェック時に存在するトピックに対して定期的にパターンマッチングを行います。
      パラメーター:
      topicPattern - パターン。
      関連事項:
      • CommonClientConfigs.METADATA_MAX_AGE_CONFIG
    • ConsumerProperties

      public ConsumerProperties(TopicPartitionOffset... topicPartitions)
      提供されたトピックパーティションを自分自身に割り当てるコンテナーのプロパティを作成します。
      パラメーター:
      topicPartitions - トピックのパーティション。
  • メソッドの詳細

    • getTopics

      @Nullable public StringSE[] getTopics()
      構成されたトピックを返します。
      戻り値:
      トピック。
    • getTopicPattern

      @Nullable public PatternSE getTopicPattern()
      構成されたトピックパターンを返します。
      戻り値:
      トピックパターン。
    • getTopicPartitions

      @Nullable public TopicPartitionOffset[] getTopicPartitions()
      構成済みの TopicPartitionOffset を返します。
      戻り値:
      トピック / パーティション。
      導入:
      2.5
    • setPollTimeout

      public void setPollTimeout(long pollTimeout)
      レコードを待機しているコンシューマーでブロックする最大時間を設定します。
      パラメーター:
      pollTimeout - ミリ秒単位のタイムアウト。デフォルトの 5000L
    • getPollTimeout

      public long getPollTimeout()
    • setGroupId

      public void setGroupId(StringSE groupId)
      このコンテナーのグループ ID を設定します。コンシューマーファクトリ構成によって提供される group.id プロパティをオーバーライドします。
      パラメーター:
      groupId - グループ ID。
    • getGroupId

      @Nullable public StringSE getGroupId()
      コンテナーのグループ ID を返します。
      戻り値:
      グループ ID。
    • getClientId

      public StringSE getClientId()
      クライアント ID を返します。
      戻り値:
      クライアント ID。
      関連事項:
    • setClientId

      public void setClientId(StringSE clientId)
      クライアント ID を設定します。コンシューマーファクトリの client.id プロパティを上書きします。並行コンテナーで使用される場合、各コンシューマーに一意の値を提供するために "-n" という接尾辞が付けられます。
      パラメーター:
      clientId - クライアント ID。
    • setConsumerRebalanceListener

      public void setConsumerRebalanceListener(org.apache.kafka.clients.consumer.ConsumerRebalanceListener consumerRebalanceListener)
      ユーザー定義の ConsumerRebalanceListener 実装を設定します。
      パラメーター:
      consumerRebalanceListener - ConsumerRebalanceListener インスタンス
    • getConsumerRebalanceListener

      @Nullable public org.apache.kafka.clients.consumer.ConsumerRebalanceListener getConsumerRebalanceListener()
      リバランスリスナーを返します。
      戻り値:
      リスナー。
    • setSyncCommitTimeout

      public void setSyncCommitTimeout(@Nullable DurationSE syncCommitTimeout)
      commitSync 操作のタイムアウトを設定します(isSyncCommits() の場合。デフォルトの api タイムアウトプロパティをオーバーライドします。
      パラメーター:
      syncCommitTimeout - タイムアウト。
      関連事項:
    • getSyncCommitTimeout

      @Nullable public DurationSE getSyncCommitTimeout()
      同期コミットタイムアウトを返します。
      戻り値:
      タイムアウト。
    • setCommitCallback

      public void setCommitCallback(org.apache.kafka.clients.consumer.OffsetCommitCallback commitCallback)
      コミットコールバックを設定します。デフォルトでは、単純なロギングコールバックを使用して、DEBUG レベルでの成功と ERROR レベルでの失敗をログに記録します。syncCommits が false の場合に使用されます。
      パラメーター:
      commitCallback - コールバック。
      関連事項:
    • setOffsetAndMetadataProvider

      public void setOffsetAndMetadataProvider(OffsetAndMetadataProvider offsetAndMetadataProvider)
      コミットコールバックに関連付けられたオフセットおよびメタデータプロバイダーを設定します。
      パラメーター:
      offsetAndMetadataProvider - オフセットおよびメタデータプロバイダー。
      導入:
      2.8.5
      関連事項:
    • getCommitCallback

      @Nullable public org.apache.kafka.clients.consumer.OffsetCommitCallback getCommitCallback()
      コミットコールバックを返します。
      戻り値:
      コールバック。
    • getOffsetAndMetadataProvider

      @Nullable public OffsetAndMetadataProvider getOffsetAndMetadataProvider()
      オフセットおよびメタデータプロバイダーを返します。
      戻り値:
      オフセットおよびメタデータプロバイダー。
    • setSyncCommits

      public void setSyncCommits(boolean syncCommits)
      コンテナーがコミットを担当するときに consumer.commitSync() または commitAsync() を呼び出すかどうかを設定します。デフォルトは true です。
      パラメーター:
      syncCommits - commitSync() を使用するのは本当です。
      関連事項:
    • isSyncCommits

      public boolean isSyncCommits()
    • getCommitLogLevel

      public LogIfLevelEnabled.Level getCommitLogLevel()
      オフセットコミットをログに記録するレベル。
      戻り値:
      レベル。
    • setCommitLogLevel

      public void setCommitLogLevel(LogIfLevelEnabled.Level commitLogLevel)
      オフセットコミットをログに記録するレベルを設定します。デフォルト: DEBUG。
      パラメーター:
      commitLogLevel - レベル。
    • getKafkaConsumerProperties

      public PropertiesSE getKafkaConsumerProperties()
      コンシューマーファクトリによって提供されるコンシューマープロパティとマージされるコンシューマープロパティを取得します。ここのプロパティは、コンシューマーファクトリの同じ名前のプロパティに優先します。文字列値以外のプロパティを追加できますが、プロパティ名(ハッシュテーブルキー)は文字列である必要があります。他のすべては無視されます。group.id と client.id は無視されます。
      戻り値:
      プロパティ。
      関連事項:
    • setKafkaConsumerProperties

      public void setKafkaConsumerProperties(PropertiesSE kafkaConsumerProperties)
      コンシューマーファクトリによって提供されるコンシューマープロパティとマージされるコンシューマープロパティを設定します。ここのプロパティは、コンシューマーファクトリ内の同じ名前を持つものに取って代わります。group.id と client.id は無視されます。プロパティキーは StringSE である必要があります。
      パラメーター:
      kafkaConsumerProperties - プロパティ。
      関連事項:
    • getAuthExceptionRetryInterval

      @Nullable public DurationSE getAuthExceptionRetryInterval()
      認証 / 認可の再試行間隔を取得します。
      戻り値:
      間隔。
    • setAuthExceptionRetryInterval

      public void setAuthExceptionRetryInterval(DurationSE authExceptionRetryInterval)
      AuthenticationException または org.apache.kafka.common.errors.AuthorizationException が KafkaConsumer によってスローされた後の再試行の間隔を設定します。デフォルトでは、フィールドは null であり、再試行は無効になっています。そのような場合、コンテナーは停止されます。間隔は、max.poll.interval.ms コンシューマープロパティよりも小さくする必要があります。
      パラメーター:
      authExceptionRetryInterval - 再試行間の期間
      導入:
      2.8
    • getCommitRetries

      public int getCommitRetries()
      true に設定された setSyncCommits(boolean) を使用しているときに、コンシューマーによって RetriableCommitFailedException がスローされたときに許可される再試行の回数。
      戻り値:
      再試行の回数。
      導入:
      2.3.9
      関連事項:
    • setCommitRetries

      public void setCommitRetries(int commitRetries)
      true に設定された setSyncCommits(boolean) を使用しているときに、コンシューマーによって RetriableCommitFailedException がスローされたときに許可される再試行回数を設定します。デフォルトの 3 (4 は合計を試行します)。
      パラメーター:
      commitRetries - commitRetries。
      導入:
      2.3.9
      関連事項:
    • isFixTxOffsets

      public boolean isFixTxOffsets()
      最終的なトランザクションオフセットを修正するかどうか。
      戻り値:
      修正するのは本当です。
      導入:
      2.5.6
      関連事項:
    • setFixTxOffsets

      public void setFixTxOffsets(boolean fixTxOffsets)
      トランザクションプロデューサーによって生成されたレコードを消費し、コンシューマーがパーティションの最後に配置されている場合、トランザクションのコミット / ロールバックと、場合によっては存在を示すために使用される疑似レコードが原因で、ラグがゼロより大きいと誤って報告される可能性があります。ロールバックされたレコードの。これは関数にはコンシューマーに影響を与えませんが、一部のユーザーは「ラグ」がゼロ以外であることに関心事を表明しています。これを true に設定すると、コンテナーはそのような誤って報告されたオフセットを修正します。チェックは、コミット処理が大幅に複雑になるのを防ぐために、次のポーリングの前に実行されます。重要: これを書いている時点では、コンシューマーが isolation.level=read_committed で構成されていて、max.poll.records が 1 より大きい場合にのみ、ラグが修正されます。詳細については、https://issues.apache.org/jira/browse/KAFKA-10683 を参照してください。
      パラメーター:
      fixTxOffsets - true の場合、オフセットを修正します。
      導入:
      2.5.6
    • isCheckDeserExWhenKeyNull

      public boolean isCheckDeserExWhenKeyNull()
      null キーを使用した逆直列化例外ヘッダーを常に確認してください。
      戻り値:
      チェックするのは本当です。
      導入:
      2.8.1
    • setCheckDeserExWhenKeyNull

      public void setCheckDeserExWhenKeyNull(boolean checkDeserExWhenKeyNull)
      null キーを受信したときに、常に DeserializationException ヘッダーをチェックするには、true に設定します。委譲デシリアライザーを使用している場合など、コンシューマーコードが ErrorHandlingDeserializer が構成されていることを判別できない場合に役立ちます。
      パラメーター:
      checkDeserExWhenKeyNull - 常にチェックするために true。
      導入:
      2.8.1
    • isCheckDeserExWhenValueNull

      public boolean isCheckDeserExWhenValueNull()
      null 値の逆直列化例外ヘッダーを常に確認してください。
      戻り値:
      チェックするのは本当です。
      導入:
      2.8.1
    • setCheckDeserExWhenValueNull

      public void setCheckDeserExWhenValueNull(boolean checkDeserExWhenValueNull)
      null 値を受け取ったときに、常に DeserializationException ヘッダーをチェックするには、true に設定します。委譲デシリアライザーを使用している場合など、コンシューマーコードが ErrorHandlingDeserializer が構成されていることを判別できない場合に役立ちます。
      パラメーター:
      checkDeserExWhenValueNull - 常にチェックするために true。
      導入:
      2.8.1
    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSEtoString 
    • renderProperties

      protected final StringSE renderProperties()