dawidwys commented on a change in pull request #15677:
URL: https://github.com/apache/flink/pull/15677#discussion_r615963800
##########
File path:
flink-core/src/main/java/org/apache/flink/api/connector/source/SplitEnumerator.java
##########
@@ -68,12 +68,26 @@
void addReader(int subtaskId);
/**
- * Checkpoints the state of this split enumerator.
+ * Creates a snapshot of the state of this split enumerator, to be stored
in a checkpoint.
*
+ * <p>The snapshot should contain the latest state of the enumerator: It
should assume that all
+ * operations that happened before the snapshot have successfully
completed. For example all
+ * splits assigned to readers via {@link
SplitEnumeratorContext#assignSplit(SourceSplit, int)}
+ * and {@link SplitEnumeratorContext#assignSplits(SplitsAssignment)})
don't need to be included
+ * in the snapshot any more.
Review comment:
```suggestion
* in the snapshot anymore.
```
##########
File path:
flink-core/src/main/java/org/apache/flink/api/connector/source/SplitEnumerator.java
##########
@@ -68,12 +68,26 @@
void addReader(int subtaskId);
/**
- * Checkpoints the state of this split enumerator.
+ * Creates a snapshot of the state of this split enumerator, to be stored
in a checkpoint.
*
+ * <p>The snapshot should contain the latest state of the enumerator: It
should assume that all
Review comment:
Thanks for extending the javadoc! That is really helpful!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
