[flink-connector-kafka] branch main updated: [FLINK-32021][kafka] Improve the java docs of SpecifiedOffsetsInitializer and TimestampOffsetsInitializer

[le...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

leonard pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/flink-connector-kafka.git


The following commit(s) were added to refs/heads/main by this push:
     new 14d8462b [FLINK-32021][kafka] Improve the java docs of SpecifiedOffsetsInitializer and TimestampOffsetsInitializer
14d8462b is described below

commit 14d8462be33c25031e94da0635105f69bb807641
Author: Hongshun Wang <12...@users.noreply.github.com>
AuthorDate: Tue Jul 11 10:24:13 2023 +0800

    [FLINK-32021][kafka] Improve the java docs of SpecifiedOffsetsInitializer and TimestampOffsetsInitializer
    
    This closes #29.
---
 .../source/enumerator/initializer/SpecifiedOffsetsInitializer.java   | 5 +++++
 .../source/enumerator/initializer/TimestampOffsetsInitializer.java   | 2 ++
 2 files changed, 7 insertions(+)

diff --git a/flink-connector-kafka/src/main/java/org/apache/flink/connector/kafka/source/enumerator/initializer/SpecifiedOffsetsInitializer.java b/flink-connector-kafka/src/main/java/org/apache/flink/connector/kafka/source/enumerator/initializer/SpecifiedOffsetsInitializer.java
index 5766a5fc..e402435b 100644
--- a/flink-connector-kafka/src/main/java/org/apache/flink/connector/kafka/source/enumerator/initializer/SpecifiedOffsetsInitializer.java
+++ b/flink-connector-kafka/src/main/java/org/apache/flink/connector/kafka/source/enumerator/initializer/SpecifiedOffsetsInitializer.java
@@ -38,6 +38,11 @@ import static org.apache.flink.util.Preconditions.checkState;
  * An implementation of {@link OffsetsInitializer} which initializes the offsets of the partition
  * according to the user specified offsets.
  *
+ * <p>Use specified offsets for specified partitions while use commit offsets or offsetResetStrategy
+ * for unspecified partitions. Specified partition's offset should be less than its latest offset,
+ * otherwise it will start from the offsetResetStrategy. The default value of offsetResetStrategy is
+ * earliest.
+ *
  * <p>Package private and should be instantiated via {@link OffsetsInitializer}.
  */
 class SpecifiedOffsetsInitializer implements OffsetsInitializer, OffsetsInitializerValidator {
diff --git a/flink-connector-kafka/src/main/java/org/apache/flink/connector/kafka/source/enumerator/initializer/TimestampOffsetsInitializer.java b/flink-connector-kafka/src/main/java/org/apache/flink/connector/kafka/source/enumerator/initializer/TimestampOffsetsInitializer.java
index f411307f..0ad53c9b 100644
--- a/flink-connector-kafka/src/main/java/org/apache/flink/connector/kafka/source/enumerator/initializer/TimestampOffsetsInitializer.java
+++ b/flink-connector-kafka/src/main/java/org/apache/flink/connector/kafka/source/enumerator/initializer/TimestampOffsetsInitializer.java
@@ -28,6 +28,8 @@ import java.util.Map;
 
 /**
  * An implementation of {@link OffsetsInitializer} to initialize the offsets based on a timestamp.
+ * If the message meeting the requirement of the timestamp have not been produced to Kafka yet, just
+ * use the latest offset.
  *
  * <p>Package private and should be instantiated via {@link OffsetsInitializer}.
  */