pyflink.common.job_client.JobClient.stop_with_savepoint

JobClient.stop_with_savepoint(advance_to_end_of_event_time: bool, savepoint_directory: str | None = None) → CompletableFuture

Stops the associated job on Flink cluster.

Stopping works only for streaming programs. Be aware, that the job might continue to run for a while after sending the stop command, because after sources stopped to emit data all operators need to finish processing.

Parameters:

• advance_to_end_of_event_time – Flag indicating if the source should inject a MAX_WATERMARK in the pipeline.

• savepoint_directory – Directory the savepoint should be written to.

Returns:

A CompletableFuture containing the path where the savepoint is located.

Added in version 1.11.0.