Skip to content

Java SDK: Document char is not supported for XCom parameters #70239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
FrankYang0529 wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −0
Open

Java SDK: Document char is not supported for XCom parameters #70239

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions airflow-core/docs/authoring-and-scheduling/language-sdks/java.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,14 @@ represented as Java objects when read back via ``getXCom``.
- object
- ``Map<String, Object>``

.. note::

``char`` and ``Character`` are not supported. JSON has no single-character type, so a
character value is stored as a JSON string (or a number) and is read back as one of the
Java types in the table above. Declaring ``char`` or ``Character`` as an
``@Builder.XCom`` parameter compiles, but reading a pushed value fails at runtime with a
``ClassCastException``. Use ``String`` instead.

.. note::

An ``@Builder.XCom`` parameter that reads a value which was never pushed resolves to
Expand Down