Updated All Externally Visible Logs/Docs from Runner V2 to Portable Runner by TongruiLi · Pull Request #38532 · apache/beam

TongruiLi · 2026-05-18T23:31:43Z

All runner v2 references have been updated to portable runner, all runner v1 references have been updated to streaming java runner.

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.

…va runner

TongruiLi · 2026-05-18T23:33:19Z

R: @shunping R: @scwhittle

gemini-code-assist · 2026-05-18T23:33:34Z

Summary of Changes

Hello, 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 standardizes the terminology used for Dataflow runners across the entire Apache Beam repository. By renaming 'Runner V2' to 'Portable Runner' and 'runner v1' to 'Streaming Java Runner', the changes improve consistency in logs, documentation, and error reporting. These updates affect multiple components, including Gradle build scripts, Go and Python SDKs, and internal protocol definitions, ensuring that the naming conventions are uniform throughout the system.

Highlights

Terminology Standardization: Renamed all instances of 'Runner V2' to 'Portable Runner' and 'runner v1' to 'Streaming Java Runner' across the codebase, including logs, documentation, and comments.
Validation and Error Messaging: Updated error messages and validation logic in both Java and Python SDKs to reflect the new naming conventions, ensuring consistency in user-facing feedback.
Documentation Updates: Updated README files and docstrings to align with the new terminology, improving clarity for developers and users.

New Features

🧠 You can now enable Memory (public preview) 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 the 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 counterproductive. 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.

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 · 2026-05-18T23:34:30Z

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

gemini-code-assist

Code Review

This pull request renames 'Runner V2' to 'Portable Runner' and 'Runner V1' to 'Streaming Java Runner' across the Java, Go, and Python SDKs, including documentation and build scripts. It also updates logic to prevent disabling the Portable Runner and adds tests for these cases. Feedback identifies a redundant word in a Java build file comment and an inconsistent error message in the Go SDK that still uses the old terminology.

gemini-code-assist · 2026-05-18T23:35:07Z

    // TODO(https://github.com/apache/beam/issues/21472)
    'org.apache.beam.sdk.transforms.GroupByKeyTest$BasicTests.testAfterProcessingTimeContinuationTriggerUsingState',
-    // GroupIntoBatches.withShardedKey not supported on streaming runner v1
+    // GroupIntoBatches.withShardedKey not supported on streaming Streaming Java Runner


The word "streaming" is redundant here as "Streaming Java Runner" already includes it.

// GroupIntoBatches.withShardedKey not supported on Streaming Java Runner

gemini-code-assist · 2026-05-18T23:35:07Z

-			return nil, errors.New("detected one of the following experiments: disable_runner_v2 | disable_runner_v2_until_2023 | disable_prime_runner_v2. Disabling runner v2 is no longer supported as of Beam version 2.45.0+")
+		// enable_portable_runner is not documented and hence wont be set by default. This will be fixed in later versions.
+		if strings.Contains(e, "disable_runner_v2") || strings.Contains(e, "disable_runner_v2_until_2023") || strings.Contains(e, "disable_prime_runner_v2") || strings.Contains(e, "disable_portable_runner") || strings.Contains(e, "enable_streaming_java_runner") {
+			return nil, errors.New("detected one of the following experiments: disable_runner_v2 | disable_runner_v2_until_2023 | disable_prime_runner_v2 | disable_portable_runner | enable_streaming_java_runner. Disabling runner v2 is no longer supported as of Beam version 2.45.0+")


For consistency with the rest of the changes in this PR and the Python SDK implementation, "runner v2" in the error message should be updated to "Portable Runner".

Suggested change

return nil, errors.New("detected one of the following experiments: disable_runner_v2 | disable_runner_v2_until_2023 | disable_prime_runner_v2 | disable_portable_runner | enable_streaming_java_runner. Disabling runner v2 is no longer supported as of Beam version 2.45.0+")

return nil, errors.New("detected one of the following experiments: disable_runner_v2 | disable_runner_v2_until_2023 | disable_prime_runner_v2 | disable_portable_runner | enable_streaming_java_runner. Disabling Portable Runner is no longer supported as of Beam version 2.45.0+")

shunping · 2026-05-19T00:51:16Z

Portable runner in Beam has a wider meaning (https://beam.apache.org/roadmap/portability/). Like Prism is a portable runner, the FnAPI Python runner is also a portable runner, etc.

Is it better if we emphasize Runner V2 as Dataflow Portable Runner? @TongruiLi

scwhittle

Also address the gemini comments.

I think that it is good idea to use Dataflow Portable Runner in contexts that it isn't immediately clear or for docs. I think that code comments in dataflow files are likely clear enough without that qualifier.

scwhittle · 2026-05-20T12:56:05Z

+
+	opts, err := getJobOptions(context.Background(), false)
+
+	if err == nil {


what are these testing? It seems it is verifying errors, but the test name doesn't indicate we expect a failure. If we do it woudl be better to verify the error more specifically too

ditto for the other test

scwhittle · 2026-05-20T12:56:58Z

 ℹ️ Note that cross-language transforms require
 portable implementations of Spark/Flink/Direct runners. Dataflow requires
-[runner V2](https://cloud.google.com/dataflow/docs/guides/deploying-a-pipeline#dataflow-runner-v2).
+[Portable Runner](https://cloud.google.com/dataflow/docs/guides/deploying-a-pipeline#dataflow-runner-v2).


how about
Dataflow requires using the [Dataflow Portable Runner]

scwhittle · 2026-05-20T12:59:14Z

    userStepToStateFamilyNameMap: Map from user step names to state families.
    userWorkerRunnerV1Settings: Binary encoded proto to control runtime
-      behavior of the java runner v1 user worker.
+      behavior of the Streaming Java Runner user worker.


think this file is generated
https://github.com/apache/beam/blob/master/sdks/python/apache_beam/runners/dataflow/internal/clients/README.txt

TongruiLi and others added 8 commits May 7, 2026 22:55

Aded portable runner to python and go runners

c9445ef

Removed empty if, added disable unit test for python.

dbb9826

Removed unnessary class in unit test

ac3716d

Removed unused variable

1069559

Merge branch 'apache:master' into master

50b4120

Merge branch 'apache:master' into master

0af5af7

Ran formatter

b846cec

Updated All Reference of Runner V2/V1 to portable runner/streaming ja…

4013e3d

…va runner

github-actions Bot added python go examples io runners dataflow labels May 18, 2026

gemini-code-assist Bot reviewed May 18, 2026

View reviewed changes

scwhittle requested changes May 20, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated All Externally Visible Logs/Docs from Runner V2 to Portable Runner#38532

Updated All Externally Visible Logs/Docs from Runner V2 to Portable Runner#38532
TongruiLi wants to merge 8 commits into
apache:masterfrom
TongruiLi:portable_runner_doc

TongruiLi commented May 18, 2026

Uh oh!

TongruiLi commented May 18, 2026

Uh oh!

gemini-code-assist Bot commented May 18, 2026

Uh oh!

github-actions Bot commented May 18, 2026

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

gemini-code-assist Bot May 18, 2026

Uh oh!

gemini-code-assist Bot May 18, 2026

Uh oh!

shunping commented May 19, 2026

Uh oh!

scwhittle left a comment

Uh oh!

scwhittle May 20, 2026

Uh oh!

scwhittle May 20, 2026

Uh oh!

scwhittle May 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	return nil, errors.New("detected one of the following experiments: disable_runner_v2 \| disable_runner_v2_until_2023 \| disable_prime_runner_v2 \| disable_portable_runner \| enable_streaming_java_runner. Disabling runner v2 is no longer supported as of Beam version 2.45.0+")
	return nil, errors.New("detected one of the following experiments: disable_runner_v2 \| disable_runner_v2_until_2023 \| disable_prime_runner_v2 \| disable_portable_runner \| enable_streaming_java_runner. Disabling Portable Runner is no longer supported as of Beam version 2.45.0+")


		opts, err := getJobOptions(context.Background(), false)

		if err == nil {

Conversation

TongruiLi commented May 18, 2026

GitHub Actions Tests Status (on master branch)

Uh oh!

TongruiLi commented May 18, 2026

Uh oh!

gemini-code-assist Bot commented May 18, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

github-actions Bot commented May 18, 2026

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist Bot May 18, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot May 18, 2026

Choose a reason for hiding this comment

Uh oh!

shunping commented May 19, 2026

Uh oh!

scwhittle left a comment

Choose a reason for hiding this comment

Uh oh!

scwhittle May 20, 2026

Choose a reason for hiding this comment

Uh oh!

scwhittle May 20, 2026

Choose a reason for hiding this comment

Uh oh!

scwhittle May 20, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants