Skip to content

Add ValueKind element metadata#38278

Draft
ahmedabu98 wants to merge 9 commits intoapache:masterfrom
ahmedabu98:value_kind
Draft

Add ValueKind element metadata#38278
ahmedabu98 wants to merge 9 commits intoapache:masterfrom
ahmedabu98:value_kind

Conversation

@ahmedabu98
Copy link
Copy Markdown
Contributor

@ahmedabu98 ahmedabu98 commented Apr 23, 2026

Adds ValueKind to the model.

Allows DoFns to output elements with a ValueKind, and receive elements with a ValueKind parameter (in the @ProcessElement method)

Support enabled in DirectRunner
Touches parts of the Dataflow legacy worker, but further work would need to be done internally

Added corresponding logic to FnAPI, but Portable runners (like Dataflow V2) would need to extend it and enable on their side


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)

Build python source distribution and wheels
Python tests
Java tests
Go tests

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
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! 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 support for Change Data Capture (CDC) metadata by adding a ValueKind concept throughout the Apache Beam SDK and Fn API. This allows for explicit tracking of data changes (INSERT, UPDATE, DELETE) in windowed elements, ensuring this metadata is correctly propagated through the execution pipeline, including serialization in Windmill and accessibility within user-defined DoFn logic.

Highlights

  • ValueKind Introduction: Introduced a new ValueKind enum to represent CDC metadata (INSERT, UPDATE_BEFORE, UPDATE_AFTER, DELETE) and integrated it into the Beam Fn API and core SDK.
  • API Expansion: Added outputWithKind methods to DoFn.WindowedContext and related runners to allow users to specify the ValueKind during output operations.
  • Dataflow Integration: Updated WindmillSink and UngroupedWindmillReader to correctly encode and decode ValueKind metadata in Windmill messages.
  • Reflect and Invoker Updates: Updated DoFnInvoker and ByteBuddyDoFnInvokerFactory to support ValueKind as a parameter in DoFn methods.

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

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.

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.

@ahmedabu98 ahmedabu98 changed the title valuekind Add ValueKind element metadata Apr 28, 2026
@github-actions github-actions Bot added the spark label Apr 28, 2026
// Register standard file systems.
FileSystems.setDefaultPipelineOptions(options);
CoderTranslation.verifyModelCodersRegistered();
WindowedValues.FullWindowedValueCoder.setMetadataSupported(true);
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Added this just to visualize. It's likely more correct to let each runner set it on their side

@ahmedabu98 ahmedabu98 mentioned this pull request Apr 28, 2026
3 tasks
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.

1 participant