root
/
kafka
mirror of https://github.com/apache/kafka.git
1
0
Fork 0
Code Issues Actions 4 Packages Projects Releases Wiki Activity

KAFKA-19060 Documented null edge cases in the Clients API JavaDoc (#19393) 

Some client APIs may return `null` values in the map, but this  behavior
isn’t documented in the JavaDoc. We should update the JavaDoc to include
these edge cases.

Reviewers: Kirk True <kirk@kirktrue.pro>, Jhen-Yung Hsu
<jhenyunghsu@gmail.com>, PoAn Yang <payang@apache.org>, Chia-Ping Tsai
<chia7712@gmail.com>
This commit is contained in:
Ken Huang 2025-05-04 20:35:02 +08:00 committed by GitHub
parent b5cceb43e5
commit c85e09f7a5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
clients/src/main/java/org/apache/kafka/clients/consumer/KafkaConsumer.java
View File

@ -1563,8 +1563,8 @@ public class KafkaConsumer<K, V> implements Consumer<K, V> {
* @param timestampsToSearch the mapping from partition to the timestamp to look up.
*
* @return a mapping from partition to the timestamp and offset of the first message with timestamp greater
* than or equal to the target timestamp. {@code null} will be returned for the partition if there is no
* such message.
* than or equal to the target timestamp. If the timestamp and offset for a specific partition cannot be found within
* the default timeout, and no corresponding message exists, the entry in the returned map will be {@code null}
* @throws org.apache.kafka.common.errors.AuthenticationException if authentication fails. See the exception for more details
* @throws org.apache.kafka.common.errors.AuthorizationException if not authorized to the topic(s). See the exception for more details
* @throws IllegalArgumentException if the target timestamp is negative
@ -1590,8 +1590,8 @@ public class KafkaConsumer<K, V> implements Consumer<K, V> {
* @param timeout The maximum amount of time to await retrieval of the offsets
*
* @return a mapping from partition to the timestamp and offset of the first message with timestamp greater
* than or equal to the target timestamp. {@code null} will be returned for the partition if there is no
* such message.
* than or equal to the target timestamp. If the timestamp and offset for a specific partition cannot be found within
* timeout, and no corresponding message exists, the entry in the returned map will be {@code null}
* @throws org.apache.kafka.common.errors.AuthenticationException if authentication fails. See the exception for more details
* @throws org.apache.kafka.common.errors.AuthorizationException if not authorized to the topic(s). See the exception for more details
* @throws IllegalArgumentException if the target timestamp is negative