org.apache.flink.api.java

Class CollectionEnvironment

java.lang.Object

org.apache.flink.api.java.ExecutionEnvironment

org.apache.flink.api.java.CollectionEnvironment

Direct Known Subclasses:

CollectionTestEnvironment

@PublicEvolving
public class CollectionEnvironment
extends ExecutionEnvironment

Version of ExecutionEnvironment that allows serial, local, collection-based executions of Flink programs.

Field Summary

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

jobID, lastJobExecutionResult, LOG, sessionTimeout

Constructor Summary

Constructors

Constructor and Description
CollectionEnvironment()

Method Summary

Modifier and Type	Method and Description
JobExecutionResult	execute(String jobName) Triggers the program execution.
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.
int	getParallelism() Gets the parallelism with which operation are executed by default.
void	startNewSession() Starts a new session, discarding the previous data flow and all of its intermediate results.

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, 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, toString, wait, wait, wait

Constructor Detail

CollectionEnvironment

public CollectionEnvironment()

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.

getParallelism

public int getParallelism()

Description copied from class: ExecutionEnvironment

Gets the parallelism with which operation are executed by default. Operations can individually override this value to use a specific parallelism via Operator.setParallelism(int). Other operations may need to run with a different parallelism - for example calling DataSet.reduce(org.apache.flink.api.common.functions.ReduceFunction) over the entire set will insert eventually an operation that runs non-parallel (parallelism of one).

Overrides:

getParallelism in class ExecutionEnvironment

Returns:

The parallelism used by operations, unless they override that value. This method returns ExecutionConfig.PARALLELISM_DEFAULT, if the environment's default parallelism should be used.

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