Github user tillrohrmann commented on a diff in the pull request:
https://github.com/apache/flink/pull/1794#discussion_r56155005
--- Diff:
flink-streaming-java/src/main/java/org/apache/flink/streaming/api/environment/StreamExecutionEnvironment.java
---
@@ -277,6 +277,29 @@ public StreamExecutionEnvironment
enableCheckpointing(long interval) {
/**
* Enables checkpointing for the streaming job. The distributed state
of the streaming
* dataflow will be periodically snapshotted. In case of a failure, the
streaming
+ * dataflow will be restarted from the latest completed checkpoint.
This method selects
+ * {@link CheckpointingMode#EXACTLY_ONCE} guarantees.
+ *
+ * <p>The job draws checkpoints periodically, in the given interval.
The state will be
+ * stored in the configured state backend.</p>
+ *
+ * <p>NOTE: Checkpointing iterative streaming dataflows in not properly
supported at
+ * the moment. For that reason, iterative jobs will not be started if
used
+ * with enabled checkpointing. To override this mechanism, use the
+ * {@link #enableCheckpointing(long, CheckpointingMode, boolean)}
method.</p>
+ *
+ * @param interval Time interval between state checkpoints in
milliseconds.
+ * @param minInterval Time interval between the last finished
checkpoint and the next one in mills.
+ */
+ public StreamExecutionEnvironment enableCheckpointing(long interval,
long minInterval) {
--- End diff --
`minInterval` might be confusing for users because it actually is the pause
between successive checkpoints.
---
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.
---
