Browse Source

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

Reviewers: Chris Egerton <chrise@aiven.io>
pull/13949/head
Yash Mayya 1 year ago committed by GitHub
parent
commit
d6aaddf6ee
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 7
      connect/api/src/main/java/org/apache/kafka/connect/source/SourceTask.java

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

@ -105,9 +105,10 @@ public abstract class SourceTask implements Task { @@ -105,9 +105,10 @@ public abstract class SourceTask implements Task {
public abstract List<SourceRecord> poll() throws InterruptedException;
/**
* <p>
* Commit the offsets, up to the offsets that have been returned by {@link #poll()}. This
* method should block until the commit is complete.
* This method is invoked periodically when offsets are committed for this source task. Note that the offsets
* being committed won't necessarily correspond to the latest offsets returned by this source task via
* {@link #poll()}. Also see {@link #commitRecord(SourceRecord, RecordMetadata)} which allows for a more
* fine-grained tracking of records that have been successfully delivered.
* <p>
* 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

Loading…
Cancel
Save