Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[fix][doc] Refine ClientBuilder#memoryLimit and ConsumerBuilder#autoScaledReceiverQueueSizeEnabled javadoc #23687

Merged
merged 1 commit into from
Dec 13, 2024

Conversation

Shawyeok
Copy link
Contributor

@Shawyeok Shawyeok commented Dec 6, 2024

Motivation

The ClientBuilder#memoryLimit was introduced in PIP-74 and originally affected producers only. In #15216, the memory limit was updated to include consumer memory usage when ConsumerBuilder#autoScaledReceiverQueueSizeEnabled is enabled. This patch updates the Javadoc to reflect the actual behavior.

Verifying this change

  • Make sure that the change passes the CI checks.

(Please pick either of the following options)

This change is a trivial rework / code cleanup without any test coverage.

Does this pull request potentially affect one of the following parts:

If the box was checked, please highlight the changes

  • Dependencies (add or upgrade a dependency)
  • The public API
  • The schema
  • The default values of configurations
  • The threading model
  • The binary protocol
  • The REST endpoints
  • The admin CLI options
  • The metrics
  • Anything that affects deployment

Documentation

  • doc
  • doc-required
  • doc-not-needed
  • doc-complete

Matching PR in forked repository

PR in forked repository:

@github-actions github-actions bot added the doc-not-needed Your PR changes do not impact docs label Dec 6, 2024
Copy link
Member

@lhotari lhotari left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dao-jun dao-jun merged commit 0845c21 into apache:master Dec 13, 2024
56 checks passed
lhotari pushed a commit that referenced this pull request Dec 16, 2024
…caledReceiverQueueSizeEnabled javadoc (#23687)

(cherry picked from commit 0845c21)
lhotari pushed a commit that referenced this pull request Dec 16, 2024
…caledReceiverQueueSizeEnabled javadoc (#23687)

(cherry picked from commit 0845c21)
nikhil-ctds pushed a commit to datastax/pulsar that referenced this pull request Dec 19, 2024
…caledReceiverQueueSizeEnabled javadoc (apache#23687)

(cherry picked from commit 0845c21)
(cherry picked from commit 0d757ad)
srinath-ctds pushed a commit to datastax/pulsar that referenced this pull request Dec 23, 2024
…caledReceiverQueueSizeEnabled javadoc (apache#23687)

(cherry picked from commit 0845c21)
(cherry picked from commit 0d757ad)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants