Add RateLimiter Abstractions

[tarun-google]

Adding Abstractions for RateLimiter.

DOC(https://s.apache.org/beam-api-ratelimiter)
POC(#37479 )

GitHub Actions Tests Status (on master branch)

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

[gemini-code-assist]

Summary of Changes

Hello @tarun-google, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces foundational abstractions for rate limiting within Apache Beam's Java SDK. It defines core interfaces for RateLimiter, RateLimiterContext, and RateLimiterFactory, enabling standardized integration of rate limiting capabilities into IO components. These changes lay the groundwork for future features where components will leverage these abstractions to manage resource consumption and prevent service overload, with the new module being included in the build system.

Highlights

• RateLimiter Interface: Introduced a new RateLimiter interface defining the allow(int permits) method for acquiring permits and blocking execution when rate limits are exceeded. Implementations must be Serializable and AutoCloseable.
• RateLimiterContext Interface: Added RateLimiterContext, a marker interface for context data required for rate limiting, ensuring serializability for worker distribution.
• RateLimiterFactory Interface: Implemented RateLimiterFactory to manage connections to rate limit services and create RateLimiter handles. It supports both static (getLimiter) and dynamic (allow) rate limiting based on context, and is also Serializable and AutoCloseable.
• New Module Inclusion: The new sdks:java:io:components module, containing these rate limiter abstractions, has been added to the Gradle build configuration in settings.gradle.kts.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• sdks/java/io/components/src/main/java/org/apache/beam/sdk/io/components/ratelimiter/RateLimiter.java
  • Added the RateLimiter interface, which defines the contract for acquiring permits and handling rate limit exceedances.
• sdks/java/io/components/src/main/java/org/apache/beam/sdk/io/components/ratelimiter/RateLimiterContext.java
  • Added the RateLimiterContext marker interface for providing context to rate limiting operations.
• sdks/java/io/components/src/main/java/org/apache/beam/sdk/io/components/ratelimiter/RateLimiterFactory.java
  • Added the RateLimiterFactory interface, responsible for creating RateLimiter instances and providing dynamic rate limiting capabilities.
• settings.gradle.kts
  • Included the new sdks:java:io:components module in the project's Gradle build settings.

Activity

• Automated GitHub Actions tests for Python, Java, and Go were triggered and their statuses are available via the provided links in the PR description.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[github-actions]

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

[tarun-google]

Run Java Wordcount Direct Runner

[tarun-google]

R: @damccorm @ahmedabu98

[github-actions]

Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment assign set of reviewers

[tarun-google]

@damccorm @ahmedabu98 Please take a look. Thanks !!

[ahmedabu98]

LGTM