Github user tzulitai commented on a diff in the pull request:
https://github.com/apache/flink/pull/2916#discussion_r90608161
--- Diff:
flink-streaming-connectors/flink-connector-kinesis/src/main/java/org/apache/flink/streaming/connectors/kinesis/proxy/KinesisProxyInterface.java
---
@@ -34,14 +34,16 @@
*
* @param shard the shard to get the iterator
* @param shardIteratorType the iterator type, defining how the shard
is to be iterated
- * (one of: TRIM_HORIZON, LATEST,
AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER)
- * @param startingSeqNum sequence number, must be null if
shardIteratorType is TRIM_HORIZON or LATEST
+ * (one of: TRIM_HORIZON, LATEST,
AT_TIMESTAMP, AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER)
+ * @param startingMarker is null if shardIteratorType is TRIM_HORIZON
or LATEST,
+ * is as a timestamp if shardIteratorType is
AT_TIMESTAMP,
+ * is as a sequence number if shardIteratorType
is AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER
--- End diff --
I would suggest the following changes to the Javadoc here to be more
specific:
is null --> "should be {@code null} if ..."
is as a timestamp --> "should be a {@code Date} value if ..."
is as a sequence number --> "should be a {@code String} representing the
sequence number if ..."
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
