Package org.apache.flink.runtime.jobmanager

Interface ExecutionPlanWriter

All Superinterfaces:
GloballyCleanableResource, LocallyCleanableResource
All Known Subinterfaces:
ExecutionPlanStore
All Known Implementing Classes:
DefaultExecutionPlanStore, StandaloneExecutionPlanStore, ThrowingExecutionPlanWriter
public interface ExecutionPlanWriter extends LocallyCleanableResource, GloballyCleanableResource
Allows to store and remove execution plans.

  • Method Details

    • putExecutionPlan

      void putExecutionPlan(ExecutionPlan executionPlan) throws Exception
      Adds the ExecutionPlan instance.

      If a execution plan with the same JobID exists, it is replaced.

      Throws:
      Exception

    • putJobResourceRequirements

      void putJobResourceRequirements(org.apache.flink.api.common.JobID jobId, JobResourceRequirements jobResourceRequirements) throws Exception
      Persist job resource requirements for the given job.
      Parameters:
      jobId - job the given requirements belong to
      jobResourceRequirements - requirements to persist
      Throws:
      Exception - in case we're not able to persist the requirements for some reason

    • localCleanupAsync

      default CompletableFuture<Void> localCleanupAsync(org.apache.flink.api.common.JobID jobId, Executor executor)
      Description copied from interface: LocallyCleanableResource
      localCleanupAsync is expected to be called from the main thread. Heavy IO tasks should be outsourced into the passed cleanupExecutor. Thread-safety must be ensured.
      Specified by:
      localCleanupAsync in interface LocallyCleanableResource
      Parameters:
      jobId - The JobID of the job for which the local data should be cleaned up.
      executor - The fallback executor for IO-heavy operations.
      Returns:
      The cleanup result future.

    • globalCleanupAsync

      default CompletableFuture<Void> globalCleanupAsync(org.apache.flink.api.common.JobID jobId, Executor executor)
      Description copied from interface: GloballyCleanableResource
      globalCleanupAsync is expected to be called from the main thread. Heavy IO tasks should be outsourced into the passed cleanupExecutor. Thread-safety must be ensured.
      Specified by:
      globalCleanupAsync in interface GloballyCleanableResource
      Parameters:
      jobId - The JobID of the job for which the local data should be cleaned up.
      executor - The fallback executor for IO-heavy operations.
      Returns:
      The cleanup result future.