org.apache.flink.streaming.api.environment

Class LocalStreamEnvironment

java.lang.Object

org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

org.apache.flink.streaming.api.environment.LocalStreamEnvironment

public class LocalStreamEnvironment
extends StreamExecutionEnvironment

The LocalStreamEnvironment is a StreamExecutionEnvironment that runs the program locally, multi-threaded, in the JVM where the environment is instantiated. It spawns an embedded Flink cluster in the background and executes the program on that cluster.

When this environment is instantiated, it uses a default parallelism of 1. The default parallelism can be set via StreamExecutionEnvironment.setParallelism(int).

Local environments can also be instantiated through StreamExecutionEnvironment.createLocalEnvironment() and StreamExecutionEnvironment.createLocalEnvironment(int). The former version will pick a default parallelism equal to the number of hardware contexts in the local machine.

Field Summary

Fields inherited from class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

checkpointingMode, checkpointInterval, DEFAULT_JOB_NAME, forceCheckpointing, isChainingEnabled, transformations

Constructor Summary

Constructors

Constructor and Description
LocalStreamEnvironment() Creates a new local stream environment that uses the default configuration.
LocalStreamEnvironment(Configuration config) Creates a new local stream environment that configures its local executor with the given configuration.

Method Summary

Methods

Modifier and Type	Method and Description
JobExecutionResult	execute(String jobName) Executes the JobGraph of the on a mini cluster of CLusterUtil with a user specified name.

Methods inherited from class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

addDefaultKryoSerializer, addDefaultKryoSerializer, addOperator, addSource, addSource, addSource, addSource, clean, createInput, createInput, createLocalEnvironment, createLocalEnvironment, createLocalEnvironment, createRemoteEnvironment, createRemoteEnvironment, createRemoteEnvironment, disableOperatorChaining, enableCheckpointing, enableCheckpointing, enableCheckpointing, enableCheckpointing, execute, fromCollection, fromCollection, fromCollection, fromCollection, fromElements, fromParallelCollection, fromParallelCollection, generateSequence, getBufferTimeout, getCheckpointingMode, getCheckpointInterval, getConfig, getExecutionEnvironment, getExecutionPlan, getNumberOfExecutionRetries, getParallelism, getStateBackend, getStreamGraph, getStreamTimeCharacteristic, initializeContextEnvironment, isChainingEnabled, isForceCheckpointing, readFile, readFileOfPrimitives, readFileOfPrimitives, readFileStream, readTextFile, readTextFile, readTextFileWithValue, readTextFileWithValue, registerType, registerTypeWithKryoSerializer, registerTypeWithKryoSerializer, resetContextEnvironment, setBufferTimeout, setDefaultLocalParallelism, setNumberOfExecutionRetries, setParallelism, setStateBackend, setStreamTimeCharacteristic, socketTextStream, socketTextStream, socketTextStream

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalStreamEnvironment

public LocalStreamEnvironment()

Creates a new local stream environment that uses the default configuration.

LocalStreamEnvironment

public LocalStreamEnvironment(Configuration config)

Creates a new local stream environment that configures its local executor with the given configuration.

Parameters:

config - The configuration used to configure the local executor.

Method Detail

execute

public JobExecutionResult execute(String jobName)
                           throws Exception

Executes the JobGraph of the on a mini cluster of CLusterUtil with a user specified name.

Specified by:

execute in class StreamExecutionEnvironment

Parameters:

jobName - name of the job

Returns:

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

Throws:

Exception - which occurs during job execution.