Skip to content

fix pipeline result naming inconsistency in Dataflow runner#38254

Open
Subramanya-Veeregowda wants to merge 2 commits intoapache:masterfrom
Subramanya-Veeregowda:fix-pipeline-result-naming
Open

fix pipeline result naming inconsistency in Dataflow runner#38254
Subramanya-Veeregowda wants to merge 2 commits intoapache:masterfrom
Subramanya-Veeregowda:fix-pipeline-result-naming

Conversation

@Subramanya-Veeregowda
Copy link
Copy Markdown
Contributor

Fixes incorrect/inconsistent pipeline result naming in the Dataflow runner.

The existing implementation had naming inconsistencies which could lead to confusion and reduced clarity in pipeline execution results.

Updated pipeline result naming logic
Ensured consistency across related components
Minor code cleanup where necessary

Built using ./gradlew :sdks:java:core:build
Ran relevant tests successfully
Verified formatting with spotlessCheck

No breaking changes introduced.

closes #18064


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 addresses naming inconsistencies regarding PipelineResult implementations across different runners in the Apache Beam codebase. By improving the documentation in both the core interface and the specific Dataflow implementation, the changes provide better clarity for developers regarding how various runners represent pipeline execution results.

Highlights

  • Documentation Update: Added Javadoc to DataflowPipelineJob to clarify its role as a PipelineResult implementation despite its historical naming.
  • Interface Clarification: Updated PipelineResult interface documentation to explicitly list and acknowledge the inconsistent naming conventions used by various runners.

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

@Subramanya-Veeregowda
Copy link
Copy Markdown
Contributor Author

@stankiewicz Hello, can you review this pr?

@github-actions
Copy link
Copy Markdown
Contributor

Assigning reviewers:

R: @Abacn for label java.

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

  • stop reviewer notifications - opt out of the automated review tooling
  • remind me after tests pass - tag the comment author after tests pass
  • waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

*
* <p>This is often a job handle to an underlying data processing engine.
*
* <p>Different runners provide their own implementations of this interface. However, the naming of
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm not sure what value addition these comments brings. these namings as part of internal implementation details doesn't affect how user consumes PipelineResult

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.

Thanks for the feedback! That makes sense — this detail may not be very useful for end users. I’ll simplify/remove the comment to keep the documentation concise.

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 21, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 58.51%. Comparing base (1cb2a71) to head (3570b25).
⚠️ Report is 12 commits behind head on master.

Additional details and impacted files
@@              Coverage Diff              @@
##             master   #38254       +/-   ##
=============================================
+ Coverage     54.61%   58.51%    +3.89%     
- Complexity     1689    15428    +13739     
=============================================
  Files          1067     2851     +1784     
  Lines        168155   280080   +111925     
  Branches       1226    12333    +11107     
=============================================
+ Hits          91844   163885    +72041     
- Misses        74116   109773    +35657     
- Partials       2195     6422     +4227     
Flag Coverage Δ
java 64.59% <ø> (-2.76%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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.

Standardize naming of PipelineResult objects

2 participants