org.apache.flink.runtime.client

Class JobClient

java.lang.Object

org.apache.flink.runtime.client.JobClient

public class JobClient
extends Object

The job client is able to submit, control, and abort jobs.

This class is thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JobClient.JobCleanUp Inner class used to perform clean up tasks when the job client is terminated.

Constructor Summary

Constructors

Constructor and Description
JobClient(JobGraph jobGraph, ClassLoader userCodeClassLoader) Constructs a new job client object and instantiates a local RPC proxy for the JobSubmissionProtocol.
JobClient(JobGraph jobGraph, Configuration configuration, ClassLoader userCodeClassLoader) Constructs a new job client object and instantiates a local RPC proxy for the JobSubmissionProtocol.
JobClient(JobGraph jobGraph, Configuration configuration, InetSocketAddress jobManagerAddress, ClassLoader userCodeClassLoader) Constructs a new job client object and instantiates a local RPC proxy for the JobSubmissionProtocol.

Method Summary

Methods

Modifier and Type	Method and Description
JobCancelResult	cancelJob() Cancels the job assigned to this job client.
void	close() Closes the JobClient by destroying the RPC stub object.
Configuration	getConfiguration() Returns the Configuration object which can include special configuration settings for the job client.
JobProgressResult	getJobProgress() Retrieves the current status of the job assigned to this job client.
int	getRecommendedPollingInterval() Returns the recommended interval in seconds in which a client is supposed to poll for progress information.
void	setConsoleStreamForReporting(PrintStream stream)
JobSubmissionResult	submitJob() Submits the job assigned to this job client to the job manager.
JobExecutionResult	submitJobAndWait() Submits the job assigned to this job client to the job manager and queries the job manager about the progress of the job until it is either finished or aborted.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JobClient

public JobClient(JobGraph jobGraph,
         ClassLoader userCodeClassLoader)
          throws IOException

Constructs a new job client object and instantiates a local RPC proxy for the JobSubmissionProtocol.

Parameters:

jobGraph - the job graph to run

Throws:

IOException - thrown on error while initializing the RPC connection to the job manager

JobClient

public JobClient(JobGraph jobGraph,
         Configuration configuration,
         ClassLoader userCodeClassLoader)
          throws IOException

Constructs a new job client object and instantiates a local RPC proxy for the JobSubmissionProtocol.

Parameters:

jobGraph - the job graph to run

configuration - configuration object which can include special configuration settings for the job client

Throws:

IOException - thrown on error while initializing the RPC connection to the job manager

JobClient

public JobClient(JobGraph jobGraph,
         Configuration configuration,
         InetSocketAddress jobManagerAddress,
         ClassLoader userCodeClassLoader)
          throws IOException

Constructs a new job client object and instantiates a local RPC proxy for the JobSubmissionProtocol.

Parameters:

jobGraph - the job graph to run

configuration - configuration object which can include special configuration settings for the job client

jobManagerAddress - IP/Port of the jobmanager (not taken from provided configuration object).

Throws:

IOException - thrown on error while initializing the RPC connection to the job manager

Method Detail

close

public void close()

Closes the JobClient by destroying the RPC stub object.

getConfiguration

public Configuration getConfiguration()

Returns the Configuration object which can include special configuration settings for the job client.

Returns:

the Configuration object which can include special configuration settings for the job client

submitJob

public JobSubmissionResult submitJob()
                              throws IOException

Submits the job assigned to this job client to the job manager.

Returns:

a JobSubmissionResult object encapsulating the results of the job submission

Throws:

IOException - thrown in case of submission errors while transmitting the data to the job manager

cancelJob

public JobCancelResult cancelJob()
                          throws IOException

Cancels the job assigned to this job client.

Returns:

a JobCancelResult object encapsulating the result of the job cancel request

Throws:

IOException - thrown if an error occurred while transmitting the request to the job manager

getJobProgress

public JobProgressResult getJobProgress()
                                 throws IOException

Retrieves the current status of the job assigned to this job client.

Returns:

a JobProgressResult object including the current job progress

Throws:

IOException - thrown if an error occurred while transmitting the request

submitJobAndWait

public JobExecutionResult submitJobAndWait()
                                    throws IOException,
                                           JobExecutionException

Submits the job assigned to this job client to the job manager and queries the job manager about the progress of the job until it is either finished or aborted.

Returns:

the duration of the job execution in milliseconds

Throws:

IOException - thrown if an error occurred while transmitting the request

JobExecutionException - thrown if the job has been aborted either by the user or as a result of an error

getRecommendedPollingInterval

public int 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

setConsoleStreamForReporting

public void setConsoleStreamForReporting(PrintStream stream)