Skip to content

Commit

Permalink
KAFKA-15091: Fix misleading Javadoc for SourceTask::commit (apache#13948
Browse files Browse the repository at this point in the history
)

Reviewers: Chris Egerton <chrise@aiven.io>
  • Loading branch information
yashmayya authored and C0urante committed Jul 18, 2023
1 parent 879de5a commit 35d4e9e
Showing 1 changed file with 4 additions and 3 deletions.
Expand Up @@ -105,9 +105,10 @@ public void initialize(SourceTaskContext context) {
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
Expand Down

0 comments on commit 35d4e9e

Please sign in to comment.