GitHub user tzulitai opened a pull request:
https://github.com/apache/flink/pull/5179
[FLINK-8260/8287] [kafka] Bunch of improvements to Kafka producer Javadocs
/ document
## What is the purpose of the change
This PR collects several improvements to the `FlinkKafkaProducer` Javadocs
and user document, with a focus on:
- Educate proper producer construction to write timestamps in Flink to
Kafka, and not demonstrate deprecated usage.
- Clarify partitioning behaviours for the producer, for all variations of
constructors that could be used.
It also has some miscellaneous trivial fixes that were found meanwhile.
## Brief change log
The commit history should serve as a clear list of what has been changed.
## Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
## Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): no
- The public API, i.e., is any changed class annotated with
`@Public(Evolving)`: no
- The serializers: no
- The runtime per-record code paths (performance sensitive): no
- Anything that affects deployment or recovery: no
- The S3 file system connector: no
## Documentation
- Does this pull request introduce a new feature? no
- If yes, how is the feature documented? n/a
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/tzulitai/flink FLINK-8260/8287
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/5179.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #5179
----
commit 47bb55a80c308506e7388715eb3b54a0c7733bcf
Author: Tzu-Li (Gordon) Tai <tzuli...@apache.org>
Date: 2017-12-18T23:21:31Z
[FLINK-8260] [kafka] Fix usage of deprecated instantiation methods in
FlinkKafkaProducer docs
commit 16fd116598b05f0b4ed4e4535fe9419767d69915
Author: Tzu-Li (Gordon) Tai <tzuli...@apache.org>
Date: 2017-12-19T04:21:20Z
[FLINK-8287] [kafka] Improve Kafka producer Javadocs / doc to clarify
partitioning behaviour
commit 51a64315d59c9dcab39f5ec52b7fa3d6599ca3fd
Author: Tzu-Li (Gordon) Tai <tzuli...@apache.org>
Date: 2017-12-19T04:29:38Z
[FLINK-8260] [kafka] Reorder deprecated / regular constructors of
FlinkKafkaProducer010
This commit moves deprecated factory methods of the
FlinkKafkaProducer010 behind regular constructors, for better navigation
and readability of the code.
commit 7219f159a7db502edf2746d1eafa835c85680931
Author: Tzu-Li (Gordon) Tai <tzuli...@apache.org>
Date: 2017-12-19T04:34:17Z
[hotfix] [kafka] Properly deprecate FlinkKafkaProducer010Configuration
FlinkKafkaProducer010Configuration is the return type of the deprecated
writeToKafkaWithTimestamp factory methods. Therefore, the class should
also be deprecated as well.
commit c84033e763c2e59ea4a21d186c0c5f29c4f2a02d
Author: Tzu-Li (Gordon) Tai <tzuli...@apache.org>
Date: 2017-12-19T04:36:31Z
[hotfix] [kafka] Fix stale Javadoc link in FlinkKafkaProducer09
The previous link was referencing a non-existent constructor signature.
commit e11f21a888a407f23d18c4c4450584443a7da4c8
Author: Tzu-Li (Gordon) Tai <tzuli...@apache.org>
Date: 2017-12-19T04:38:32Z
[hotfix] [kafka] Add serialVersionUID to FlinkKafkaProducer010
----
---
