Bigtable: provide method to pass in encoded row filter

[mutianf]

Needed to use in dataflow template.

---

Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

• Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
• Update CHANGES.md with noteworthy changes.
• If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

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 @mutianf, 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 a new capability to specify Bigtable row filters using a Base64 encoded string. This change is particularly beneficial for use cases where RowFilter objects cannot be directly passed, such as in Dataflow templates, by providing an alternative, serialized mechanism for filter definition. The update includes new API methods, utility functions for encoding/decoding, and corresponding test coverage.

Highlights

• New API for Encoded Row Filters: Introduced a new method withEncodedRowFilter in BigtableIO.Read that allows users to specify a row filter as a Base64 encoded string, enhancing flexibility for scenarios like Dataflow templates.
• Row Filter Encoding/Decoding Utilities: Added encodeRowFilter and decodeRowFilter utility methods to RowUtils for converting RowFilter objects to and from Base64 encoded strings.
• Enhanced Row Filter Retrieval Logic: Modified the getRowFilter method in BigtableIO.Read.BigtableReadOptions to first check for a direct RowFilter and then attempt to decode an encodedRowFilter if available.
• Test Coverage for Encoded Filters: Included a new test case testReadingWithSerializedRowFilter in BigtableIOTest to validate the functionality of reading data using an encoded row filter.

🧠 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/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigtable/BigtableIO.java
  • Imported InvalidProtocolBufferException.
  • Added withEncodedRowFilter method to BigtableIO.Read.
  • Updated getRowFilter to support decoding a serialized row filter if a direct RowFilter is not present.
• sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigtable/BigtableReadOptions.java
  • Added abstract getEncodedRowFilter method.
  • Added abstract setEncodedRowFilter method to the builder.
  • Included serializedRowFilter in populateDisplayData.
• sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigtable/RowUtils.java
  • Imported RowFilter, InvalidProtocolBufferException, and Base64.
  • Added static encodeRowFilter method to convert RowFilter to a Base64 string.
  • Added static decodeRowFilter method to convert a Base64 string back to a RowFilter.
• sdks/java/io/google-cloud-platform/src/test/java/org/apache/beam/sdk/io/gcp/bigtable/BigtableIOTest.java
  • Added testReadingWithSerializedRowFilter to verify the new functionality.

Activity

• The pull request was authored by mutianf.
• The author stated the need for this feature in Dataflow templates.
• The pull request includes a standard contribution checklist.
• CI build statuses for Python, Java, and Go tests on the master branch are displayed.

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. ↩