org.apache.flink.api.java

Class LocalEnvironment

java.lang.Object

org.apache.flink.api.java.ExecutionEnvironment

org.apache.flink.api.java.LocalEnvironment

public class LocalEnvironment
extends ExecutionEnvironment

An ExecutionEnvironment that runs the program locally, multi-threaded, in the JVM where the environment is instantiated. When this environment is instantiated, it uses a default degree of parallelism of 1. Local environments can also be instantiated through ExecutionEnvironment.createLocalEnvironment() and ExecutionEnvironment.createLocalEnvironment(int). The former version will pick a default degree of parallelism equal to the number of hardware contexts in the local machine.

Constructor Summary

Constructors

Constructor and Description
LocalEnvironment() Creates a new local environment.

Method Summary

Methods

Modifier and Type	Method and Description
void	disableLogging() Completely disables logging during the execution of programs in the local environment.
void	enableLogging() Causes the local environment to print INFO level log messages to the standard error output.
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.
boolean	isLoggingEnabled() Checks whether logging during the program execution is enabled or disabled.
String	toString()

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

createInput, createInput, createLocalEnvironment, createLocalEnvironment, createProgramPlan, createProgramPlan, createRemoteEnvironment, createRemoteEnvironment, disableLocalExecution, execute, fromCollection, fromCollection, fromCollection, fromCollection, fromElements, fromParallelCollection, fromParallelCollection, generateSequence, getDegreeOfParallelism, getExecutionEnvironment, getId, getIdString, initializeContextEnvironment, isContextEnvironmentSet, localExecutionIsAllowed, readCsvFile, readFile, readTextFile, readTextFile, readTextFileWithValue, readTextFileWithValue, registerCachedFile, registerCachedFile, registerCachedFilesWithPlan, setDefaultLocalParallelism, setDegreeOfParallelism

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalEnvironment

public LocalEnvironment()

Creates a new local environment.

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.

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.

enableLogging

public void enableLogging()

Causes the local environment to print INFO level log messages to the standard error output.

disableLogging

public void disableLogging()

Completely disables logging during the execution of programs in the local environment.

isLoggingEnabled

public boolean isLoggingEnabled()

Checks whether logging during the program execution is enabled or disabled.

By default, logging is turned off.

Returns:

True, if logging is enabled, false otherwise.

toString

public String toString()

Overrides:

toString in class Object