Skip to content

[FLINK-39672][docs] Document Java records as supported POJO types#28177

Merged
leonardBang merged 1 commit into
apache:release-2.2from
liuml07:FLINK-39672-release-2.2
May 20, 2026
Merged

[FLINK-39672][docs] Document Java records as supported POJO types#28177
leonardBang merged 1 commit into
apache:release-2.2from
liuml07:FLINK-39672-release-2.2

Conversation

@liuml07

@liuml07 liuml07 commented May 17, 2026

Copy link
Copy Markdown
Member

What is the purpose of the change

This backports PR #28149 to release-2.2 for FLINK-39672

Java records have been supported as POJO types since Flink 1.19 (FLINK-32380), but the only doc mention lived on the release-1.20 java_compatibility page and was inadvertently removed on master by FLINK-37339.

Brief change log

  • Restores the FLINK-32380 reference under "Java 17" in java_compatibility.md and notes that records are handled as POJO types serialized via their canonical constructor.
  • Adds a note in both POJO listings in types_serialization.md that a public record class is serialized by PojoSerializer; the no-argument constructor and getter/setter requirements do not apply.
  • Mentions in schema_evolution.md that records follow the same POJO schema evolution rules.

Parallel updates in docs/content.zh.

Verifying this change

Doc-only change.

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): (yes / no)
  • The public API, i.e., is any changed class annotated with @Public(Evolving): (yes / no)
  • The serializers: (yes / no / don't know)
  • The runtime per-record code paths (performance sensitive): (yes / no / don't know)
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: (yes / no / don't know)
  • The S3 file system connector: (yes / no / don't know)

Documentation

  • Does this pull request introduce a new feature? (yes / no)
  • If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)

Was generative AI tooling used to co-author this PR?
  • Yes (please specify the tool below)

Generated-by: Claude Opus 4.7

@flinkbot

flinkbot commented May 17, 2026

Copy link
Copy Markdown
Collaborator

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

@snuyanzin snuyanzin left a comment

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.

@liuml07 instead of having AI as a co-author can you changed it to generated by as mentioned at
https://github.com/apache/flink/blame/1e6a73616eb4e224a149e684c832f20bcba93148/AGENTS.md#L327

Generated-by: Claude Opus 4.7 (1M context)
(cherry picked from commit 1990310)
@liuml07 liuml07 force-pushed the FLINK-39672-release-2.2 branch from 26ec162 to e9bf8ac Compare May 19, 2026 18:47
@liuml07

liuml07 commented May 19, 2026

Copy link
Copy Markdown
Member Author

#28179 (comment)

@leonardBang leonardBang merged commit 3a30ae9 into apache:release-2.2 May 20, 2026
@liuml07 liuml07 deleted the FLINK-39672-release-2.2 branch May 20, 2026 19:16
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.

4 participants