[improve][client] Document that enableRetry is required for retry letter topic settings - #26286
Open
MsfPablo wants to merge 1 commit into
Open
[improve][client] Document that enableRetry is required for retry letter topic settings#26286MsfPablo wants to merge 1 commit into
MsfPablo wants to merge 1 commit into
Conversation
…ter topic settings ### Motivation The `deadLetterPolicy` javadoc shows retry/DLQ configuration without mentioning that `enableRetry(true)` is required for the retry letter topic settings to take effect, which is misleading (apache#24775). ### Modifications Add a javadoc example on `ConsumerBuilder#deadLetterPolicy` showing `enableRetry(true)` alongside `retryLetterTopic`, and a cross-reference on `ConsumerBuilder#enableRetry`. Assisted-by: Claude Code (Opus 5)
void-ptr974
approved these changes
Aug 9, 2026
void-ptr974
left a comment
void-ptr974
left a comment
Contributor
There was a problem hiding this comment.
Thanks for working on this and for clarifying the relationship between deadLetterPolicy and enableRetry(true). The added Javadocs are technically correct and make the retry-topic behavior much clearer.
One non-blocking suggestion: it would also be helpful to add the same enableRetry(true) requirement to the Javadocs of DeadLetterPolicy#retryLetterTopic and DeadLetterPolicy#retryLetterProducerBuilderCustomizer. Users may discover these options directly through the DeadLetterPolicy builder or IDE completion, and the current field-level Javadocs still do not mention that dependency.
Overall, the change looks good to me.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
The
deadLetterPolicyjavadoc shows retry/DLQ configuration without mentioning thatenableRetry(true)is required for the retry letter topic settings to take effect, which is misleading. Fixes #24775.Modifications
Add a javadoc example on
ConsumerBuilder#deadLetterPolicyshowingenableRetry(true)alongsideretryLetterTopic, and a cross-reference onConsumerBuilder#enableRetry.Assisted-by: Claude Code (Opus 5)