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

KAFKA-15091: Fix misleading Javadoc for SourceTask::commit (#13948) 

Reviewers: Chris Egerton <chrise@aiven.io>
This commit is contained in:
Yash Mayya 2023-07-18 21:38:30 +01:00 committed by GitHub
parent 5cb2504c49
commit d6aaddf6ee
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
connect/api/src/main/java/org/apache/kafka/connect/source/SourceTask.java
View File

@ -105,9 +105,10 @@ public abstract class SourceTask implements Task {
public abstract List<SourceRecord> poll() throws InterruptedException; public abstract List<SourceRecord> poll() throws InterruptedException;
/** /**
* <p> * This method is invoked periodically when offsets are committed for this source task. Note that the offsets
* Commit the offsets, up to the offsets that have been returned by {@link #poll()}. This * being committed won't necessarily correspond to the latest offsets returned by this source task via
* method should block until the commit is complete. * {@link #poll()}. Also see {@link #commitRecord(SourceRecord, RecordMetadata)} which allows for a more
* fine-grained tracking of records that have been successfully delivered.
* <p> * <p>
* SourceTasks are not required to implement this functionality; Kafka Connect will record offsets * SourceTasks are not required to implement this functionality; Kafka Connect will record offsets
* automatically. This hook is provided for systems that also need to store offsets internally * automatically. This hook is provided for systems that also need to store offsets internally