Repository navigation
Java SDK: Rewrite the user docs around Dag definition - #74701
Open
jason810496 wants to merge 2 commits into
Open
jason810496 wants to merge 2 commits into
jason810496 wants to merge 2 commits into
Conversation
jason810496
force-pushed
the
docs/java-sdk/align-user-docs
branch
from
October 20, 2026 01:53
83a51e0 to
6cf0e4f
Compare
Reorder the Java SDK guide to start from a Dag defined in Java, document conditions, switches and TriggerDagRun, and add a table of how stub task arguments bind. Split the README into a user landing page and DEVELOPMENT.md, and add an example README. Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
jason810496
force-pushed
the
docs/java-sdk/align-user-docs
branch
from
October 20, 2026 02:07
6cf0e4f to
bd256f1
Compare
jason810496
marked this pull request as ready for review
October 20, 2026 03:55
jason810496
requested review from
amoghrajesh,
ashb,
bugraoz93,
gopidesupavan,
jscheffl,
potiuk and
uranusjr
as code owners
October 20, 2026 03:55
FrankYang0529
left a comment
FrankYang0529
left a comment
Member
There was a problem hiding this comment.
Thanks for the PR. Leave some comments.
Comment on lines
+478
to
+479
| @Airflow.Task | ||
| public TriggerDagRun triggerDownstream() { |
Member
There was a problem hiding this comment.
Do we need to add queue here like other tasks?
Comment on lines
+68
to
+70
| | `java_native_annotation_example` | `AnnotationExample.java` | The annotation style: task inputs, a task group, `@Airflow.If`, `@Airflow.Switch`, and `TriggerDagRun` | | ||
| | `java_native_interface_example` | `InterfaceExample.java` | A similar Dag in the interface style, with `DagDef` | | ||
| | `java_native_target_example` | `TargetExample.java` | The Dag the other two trigger | |
Member
There was a problem hiding this comment.
No task in nativedag/*.java sets a queue. We need to add it, so users can follow the example to run the dag.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The Java SDK guide started from stub tasks of a Python Dag and did not cover conditions, switches or
TriggerDagRun, and the README mixed user docs with the contributor and release guide.What
java.rst: rewrite it in the same order as the TypeScript guide.@Airflow.If/dag.If,@Airflow.Switch/dag.SwitchandTriggerDagRun.Clientmethods and the logging integrations.java-sdk/README.md: keep installation, a quick start, links to the guide and the compatibility matrix.java-sdk/DEVELOPMENT.md: new, holding the build, release and contributing content moved from the README. References to it are updated.java-sdk/example/README.md: new, listing the example Dags under "Dag definition" and "Python Dag with stub TaskHandler".java-sdk/sdk/module.md(API reference landing page): add a quick start.Was generative AI tooling used to co-author this PR?