org.apache.flink.runtime.jobmanager

Interface SubmittedJobGraphStore

All Known Implementing Classes:

SingleJobSubmittedJobGraphStore, StandaloneSubmittedJobGraphStore, ZooKeeperSubmittedJobGraphStore

public interface SubmittedJobGraphStore

SubmittedJobGraph instances for recovery.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SubmittedJobGraphStore.SubmittedJobGraphListener A listener for SubmittedJobGraph instances.

Method Summary

Modifier and Type	Method and Description
Collection<org.apache.flink.api.common.JobID>	getJobIds() Get all job ids of submitted job graphs to the submitted job graph store.
void	putJobGraph(SubmittedJobGraph jobGraph) Adds the SubmittedJobGraph instance.
SubmittedJobGraph	recoverJobGraph(org.apache.flink.api.common.JobID jobId) Returns the SubmittedJobGraph with the given JobID or null if no job was registered.
void	releaseJobGraph(org.apache.flink.api.common.JobID jobId) Releases the locks on the specified JobGraph.
void	removeJobGraph(org.apache.flink.api.common.JobID jobId) Removes the SubmittedJobGraph with the given JobID if it exists.
void	start(SubmittedJobGraphStore.SubmittedJobGraphListener jobGraphListener) Starts the SubmittedJobGraphStore service.
void	stop() Stops the SubmittedJobGraphStore service.

Method Detail

start

void start(SubmittedJobGraphStore.SubmittedJobGraphListener jobGraphListener)
    throws Exception

Starts the SubmittedJobGraphStore service.

Throws:

Exception

stop

void stop()
   throws Exception

Stops the SubmittedJobGraphStore service.

Throws:

Exception

recoverJobGraph

@Nullable
SubmittedJobGraph recoverJobGraph(org.apache.flink.api.common.JobID jobId)
                                     throws Exception

Returns the SubmittedJobGraph with the given JobID or null if no job was registered.

Throws:

Exception

putJobGraph

void putJobGraph(SubmittedJobGraph jobGraph)
          throws Exception

Adds the SubmittedJobGraph instance.

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

Throws:

Exception

removeJobGraph

void removeJobGraph(org.apache.flink.api.common.JobID jobId)
             throws Exception

Removes the SubmittedJobGraph with the given JobID if it exists.

Throws:

Exception

releaseJobGraph

void releaseJobGraph(org.apache.flink.api.common.JobID jobId)
              throws Exception

Releases the locks on the specified JobGraph. Releasing the locks allows that another instance can delete the job from the SubmittedJobGraphStore.

Parameters:

jobId - specifying the job to release the locks for

Throws:

Exception - if the locks cannot be released

getJobIds

Collection<org.apache.flink.api.common.JobID> getJobIds()
                                                 throws Exception

Get all job ids of submitted job graphs to the submitted job graph store.

Returns:

Collection of submitted job ids

Throws:

Exception - if the operation fails