Package org.apache.flink.core.execution

Interface JobClient

@PublicEvolving public interface JobClient
A client that is scoped to a specific job.

  • Method Details

    • getJobID

      org.apache.flink.api.common.JobID getJobID()
      Returns the JobID that uniquely identifies the job this client is scoped to.

    • getJobStatus

      CompletableFuture<org.apache.flink.api.common.JobStatus> getJobStatus()
      Requests the JobStatus of the associated job.

    • cancel

      CompletableFuture<Void> cancel()
      Cancels the associated job.

    • stopWithSavepoint

      CompletableFuture<String> stopWithSavepoint(boolean advanceToEndOfEventTime, @Nullable String savepointDirectory, org.apache.flink.core.execution.SavepointFormatType formatType)
      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:
      advanceToEndOfEventTime - flag indicating if the source should inject a MAX_WATERMARK in the pipeline
      savepointDirectory - directory the savepoint should be written to
      formatType - binary format of the savepoint
      Returns:
      a CompletableFuture containing the path where the savepoint is located

    • triggerSavepoint

      CompletableFuture<String> triggerSavepoint(@Nullable String savepointDirectory, org.apache.flink.core.execution.SavepointFormatType formatType)
      Triggers a savepoint for the associated job. The savepoint will be written to the given savepoint directory, or CheckpointingOptions.SAVEPOINT_DIRECTORY if it is null.
      Parameters:
      savepointDirectory - directory the savepoint should be written to
      formatType - binary format of the savepoint
      Returns:
      a CompletableFuture containing the path where the savepoint is located

    • getAccumulators

      CompletableFuture<Map<String,Object>> getAccumulators()
      Requests the accumulators of the associated job. Accumulators can be requested while it is running or after it has finished. The class loader is used to deserialize the incoming accumulator results.

    • getJobExecutionResult

      CompletableFuture<org.apache.flink.api.common.JobExecutionResult> getJobExecutionResult()
      Returns the result of the job execution of the submitted job.

    • reportHeartbeat

      default void reportHeartbeat(long expiredTimestamp)
      The client reports the heartbeat to the dispatcher for aliveness.