hachikuji commented on a change in pull request #9512:
URL: https://github.com/apache/kafka/pull/9512#discussion_r534485088
##########
File path: raft/src/main/java/org/apache/kafka/raft/RaftClient.java
##########
@@ -100,4 +102,15 @@ default void handleResign() {}
*/
CompletableFuture<Void> shutdown(int timeoutMs);
+ /**
+ * Create a writable snapshot file for a given offset and epoch.
+ *
+ * The RaftClient assumes that the snapshot return will contain the
records up to but
+ * not including the end offset in the snapshot id. See {@link
SnapshotWriter} for
+ * details on how to use this object.
+ *
+ * @param snapshotId the end offset and epoch that identifies the snapshot
Review comment:
Just curious. Thought it might be worth mentioning the expectation in
the javadoc.
----------------------------------------------------------------
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:
us...@infra.apache.org
