apache/beam

Standardize naming of PipelineResult objects

Open

#18,064 opened on Jun 3, 2022

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Java (4,097 forks)batch import
P3coregood first issueimprovementjavapython

Repository metrics

Stars
 (7,313 stars)
PR merge metrics
 (Avg merge 6d) (243 merged PRs in 30d)

Description

Today:

PipelineResult is an interface returned by running a pipeline. DataflowPipelineJob is the Dataflow implementation of that interface FlinkRunnerResult is the Flink implementation EvaluationContext is the Spark implementation DirectPipelineResult is the DirectRunner implementation

Ideally, all the names would indicate that they are a PipelineResult, like the DirectRunner does.

Imported from Jira BEAM-726. Original Jira may contain additional context. Reported by: bchambers.

Contributor guide

Research direction
Find all classes implementing PipelineResult and rename them to follow the pattern 'XxxPipelineResult' (e.g., DataflowPipelineResult, FlinkPipelineResult). Update all references.
Tech stack
java
Domain
backendapi
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70