apache / apache/beam

[Feature Request]: Documentation about the use of MultiOutputReceiver

Open
#22,887 1 comment 0 reactions 0 assignees View on GitHub
core java new feature P3 website
Dominant language
Java
Stars
8.7k
Forks
4.7k
Avg merge
2d 2h
Merged PRs (30d)
205

Description

### What would you like to happen?

There are multiple ways to output data from a DoFn with multiple outputs:
- `DoFn.WindowedContext#output(TupleTag, T)`
- `DoFn.MultiOutputReceiver#get(TupleTag).output(T)`
Are there any reasons, other than stylistic ones, to prefer one over the other?

Generally the @ProcessElement marked method of a DoFn has a confusing number of options.

### Issue Priority

Priority: 3

### Issue Component

Component: beam-model

Contributor guide

Open the contributing guide

Research direction

Start by comparing DoFn.WindowedContext#output(TupleTag, T) with DoFn.MultiOutputReceiver#get(TupleTag).output(T), and review the @ProcessElement options mentioned in the issue. Done means the documentation explains when to prefer each multi-output approach and clarifies the available @ProcessElement options.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.