org.apache.flink.client.program

Class ContextEnvironment

java.lang.Object

org.apache.flink.api.java.ExecutionEnvironment

org.apache.flink.client.program.ContextEnvironment

Direct Known Subclasses:

DetachedEnvironment

public class ContextEnvironment
extends ExecutionEnvironment

Execution Environment for remote execution with the Client.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<URL>	classpathsToAttach
protected ClusterClient	client
protected List<URL>	jarFilesToAttach
protected SavepointRestoreSettings	savepointSettings
protected ClassLoader	userCodeClassLoader

Fields inherited from class org.apache.flink.api.java.ExecutionEnvironment

jobID, lastJobExecutionResult, LOG, sessionTimeout

Constructor Summary

Constructors

Constructor and Description
ContextEnvironment(ClusterClient remoteConnection, List<URL> jarFiles, List<URL> classpaths, ClassLoader userCodeClassLoader, SavepointRestoreSettings savepointSettings)

Method Summary

Modifier and Type	Method and Description
JobExecutionResult	execute(String jobName) Triggers the program execution.
List<URL>	getClasspaths()
ClusterClient	getClient()
String	getExecutionPlan() Creates the plan with which the system will execute the program, and returns it as a String using a JSON representation of the execution data flow graph.
List<URL>	getJars()
SavepointRestoreSettings	getSavepointRestoreSettings()
ClassLoader	getUserCodeClassLoader()
void	startNewSession() Starts a new session, discarding the previous data flow and all of its intermediate results.
String	toString()

Methods inherited from class org.apache.flink.api.java.ExecutionEnvironment

addDefaultKryoSerializer, addDefaultKryoSerializer, areExplicitEnvironmentsAllowed, createCollectionsEnvironment, createInput, createInput, createLocalEnvironment, createLocalEnvironment, createLocalEnvironment, createLocalEnvironmentWithWebUI, createProgramPlan, createProgramPlan, createProgramPlan, createRemoteEnvironment, createRemoteEnvironment, createRemoteEnvironment, execute, fromCollection, fromCollection, fromCollection, fromCollection, fromElements, fromElements, fromParallelCollection, fromParallelCollection, generateSequence, getConfig, getDefaultLocalParallelism, getExecutionEnvironment, getId, getIdString, getLastJobExecutionResult, getNumberOfExecutionRetries, getParallelism, getRestartStrategy, getSessionTimeout, initializeContextEnvironment, readCsvFile, readFile, readFileOfPrimitives, readFileOfPrimitives, readTextFile, readTextFile, readTextFileWithValue, readTextFileWithValue, registerCachedFile, registerCachedFile, registerCachedFilesWithPlan, registerType, registerTypeWithKryoSerializer, registerTypeWithKryoSerializer, resetContextEnvironment, setDefaultLocalParallelism, setNumberOfExecutionRetries, setParallelism, setRestartStrategy, setSessionTimeout

Methods inherited from class java.lang.Object

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

Field Detail

client

protected final ClusterClient client

jarFilesToAttach

protected final List<URL> jarFilesToAttach

classpathsToAttach

protected final List<URL> classpathsToAttach

userCodeClassLoader

protected final ClassLoader userCodeClassLoader

savepointSettings

protected final SavepointRestoreSettings savepointSettings

Constructor Detail

ContextEnvironment

public ContextEnvironment(ClusterClient remoteConnection,
                          List<URL> jarFiles,
                          List<URL> classpaths,
                          ClassLoader userCodeClassLoader,
                          SavepointRestoreSettings savepointSettings)

Method Detail

execute

public JobExecutionResult execute(String jobName)
                           throws Exception

Description copied from class: ExecutionEnvironment

Triggers the program execution. The environment will execute all parts of the program that have resulted in a "sink" operation. Sink operations are for example printing results (DataSet.print(), writing results (e.g. DataSet.writeAsText(String), DataSet.write(org.apache.flink.api.common.io.FileOutputFormat, String), or other generic data sinks created with DataSet.output(org.apache.flink.api.common.io.OutputFormat).

The program execution will be logged and displayed with the given job name.

Specified by:

execute in class ExecutionEnvironment

Returns:

The result of the job execution, containing elapsed time and accumulators.

Throws:

Exception - Thrown, if the program executions fails.

getExecutionPlan

public String getExecutionPlan()
                        throws Exception

Description copied from class: ExecutionEnvironment

Creates the plan with which the system will execute the program, and returns it as a String using a JSON representation of the execution data flow graph. Note that this needs to be called, before the plan is executed.

Specified by:

getExecutionPlan in class ExecutionEnvironment

Returns:

The execution plan of the program, as a JSON String.

Throws:

Exception - Thrown, if the compiler could not be instantiated, or the master could not be contacted to retrieve information relevant to the execution planning.

startNewSession

public void startNewSession()
                     throws Exception

Description copied from class: ExecutionEnvironment

Starts a new session, discarding the previous data flow and all of its intermediate results.

Specified by:

startNewSession in class ExecutionEnvironment

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object

getClient

public ClusterClient getClient()

getJars

public List<URL> getJars()

getClasspaths

public List<URL> getClasspaths()

getUserCodeClassLoader

public ClassLoader getUserCodeClassLoader()

getSavepointRestoreSettings

public SavepointRestoreSettings getSavepointRestoreSettings()