org.apache.flink.runtime.protocols

Interface JobManagementProtocol

All Superinterfaces:

ServiceDiscoveryProtocol, VersionedProtocol

All Known Subinterfaces:

ExtendedManagementProtocol

All Known Implementing Classes:

JobManager

public interface JobManagementProtocol
extends ServiceDiscoveryProtocol

The JobManagementProtocol specifies methods required to manage jobs from a job client.

Method Summary

Methods

Modifier and Type	Method and Description
JobCancelResult	cancelJob(JobID jobID) Requests to cancel the job specified by the given ID.
JobProgressResult	getJobProgress(JobID jobID) Retrieves the current status of the job specified by the given ID.
IntegerRecord	getRecommendedPollingInterval() Returns the recommended interval in seconds in which a client is supposed to poll for progress information.
JobSubmissionResult	submitJob(JobGraph job) Submits the specified job to the job manager.

Methods inherited from interface org.apache.flink.runtime.protocols.ServiceDiscoveryProtocol

getBlobServerPort

Method Detail

submitJob

JobSubmissionResult submitJob(JobGraph job)
                              throws IOException

Submits the specified job to the job manager.

Parameters:

job - the job to be executed

Returns:

a protocol of the job submission including the success status

Throws:

IOException - thrown if an error occurred while transmitting the submit request

getJobProgress

JobProgressResult getJobProgress(JobID jobID)
                                 throws IOException

Retrieves the current status of the job specified by the given ID. Consecutive calls of this method may result in duplicate events. The caller must take care of this.

Parameters:

jobID - the ID of the job

Returns:

a JobProgressResult object including the current job progress

Throws:

IOException - thrown if an error occurred while transmitting the request

cancelJob

JobCancelResult cancelJob(JobID jobID)
                          throws IOException

Requests to cancel the job specified by the given ID.

Parameters:

jobID - the ID of the job

Returns:

a JobCancelResult containing the result of the cancel request

Throws:

IOException - thrown if an error occurred while transmitting the request

getRecommendedPollingInterval

IntegerRecord getRecommendedPollingInterval()
                                            throws IOException

Returns the recommended interval in seconds in which a client is supposed to poll for progress information.

Returns:

the interval in seconds

Throws:

IOException - thrown if an error occurred while transmitting the request