org.apache.flink.runtime.jobmanager

Interface JobGraphWriter

All Superinterfaces:

GloballyCleanableResource, LocallyCleanableResource

All Known Subinterfaces:

JobGraphStore

All Known Implementing Classes:

DefaultJobGraphStore, StandaloneJobGraphStore, ThrowingJobGraphWriter

public interface JobGraphWriter
extends LocallyCleanableResource, GloballyCleanableResource

Allows to store and remove job graphs.

Method Summary

Modifier and Type	Method and Description
default CompletableFuture<Void>	globalCleanupAsync(JobID jobId, Executor executor) globalCleanupAsync is expected to be called from the main thread.
default CompletableFuture<Void>	localCleanupAsync(JobID jobId, Executor executor) localCleanupAsync is expected to be called from the main thread.
void	putJobGraph(JobGraph jobGraph) Adds the JobGraph instance.
void	putJobResourceRequirements(JobID jobId, JobResourceRequirements jobResourceRequirements) Persist job resource requirements for the given job.

Method Detail

putJobGraph

void putJobGraph(JobGraph jobGraph)
          throws Exception

Adds the JobGraph instance.

If a job graph with the same JobID exists, it is replaced.

Throws:

Exception

putJobResourceRequirements

void putJobResourceRequirements(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(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(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.