org.apache.flink.streaming.util

Class TestStreamEnvironment

java.lang.Object

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

org.apache.flink.streaming.util.TestStreamEnvironment

public class TestStreamEnvironment
extends StreamExecutionEnvironment

A StreamExecutionEnvironment that executes its jobs on MiniCluster.

Field Summary

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

cacheFile, DEFAULT_JOB_NAME, isChainingEnabled, transformations

Constructor Summary

Constructors

Constructor and Description
TestStreamEnvironment(JobExecutor jobExecutor, int parallelism)
TestStreamEnvironment(JobExecutor jobExecutor, int parallelism, Collection<Path> jarFiles, Collection<URL> classPaths)

Method Summary

Modifier and Type	Method and Description
JobExecutionResult	execute(StreamGraph streamGraph) Triggers the program execution.
static void	setAsContext(JobExecutor jobExecutor, int parallelism) Sets the streaming context environment to a TestStreamEnvironment that runs its programs on the given cluster with the given default parallelism.
static void	setAsContext(JobExecutor jobExecutor, int parallelism, Collection<Path> jarFiles, Collection<URL> classpaths) Sets the streaming context environment to a TestStreamEnvironment that runs its programs on the given cluster with the given default parallelism and the specified jar files and class paths.
static void	unsetAsContext() Resets the streaming context environment to null.

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

addDefaultKryoSerializer, addDefaultKryoSerializer, addOperator, addSource, addSource, addSource, addSource, clean, clearJobListeners, configure, createInput, createInput, createLocalEnvironment, createLocalEnvironment, createLocalEnvironment, createLocalEnvironmentWithWebUI, createRemoteEnvironment, createRemoteEnvironment, createRemoteEnvironment, disableOperatorChaining, enableCheckpointing, enableCheckpointing, enableCheckpointing, enableCheckpointing, execute, execute, executeAsync, executeAsync, executeAsync, fromCollection, fromCollection, fromCollection, fromCollection, fromElements, fromElements, fromParallelCollection, fromParallelCollection, generateSequence, getBufferTimeout, getCachedFiles, getCheckpointConfig, getCheckpointingMode, getCheckpointInterval, getConfig, getConfiguration, getDefaultLocalParallelism, getExecutionEnvironment, getExecutionPlan, getJobListeners, getMaxParallelism, getNumberOfExecutionRetries, getParallelism, getRestartStrategy, getStateBackend, getStreamGraph, getStreamGraph, getStreamGraph, getStreamTimeCharacteristic, initializeContextEnvironment, isChainingEnabled, isForceCheckpointing, readFile, readFile, readFile, readFile, readFileStream, readTextFile, readTextFile, registerCachedFile, registerCachedFile, registerJobListener, registerType, registerTypeWithKryoSerializer, registerTypeWithKryoSerializer, resetContextEnvironment, setBufferTimeout, setDefaultLocalParallelism, setMaxParallelism, setNumberOfExecutionRetries, setParallelism, setRestartStrategy, setStateBackend, setStateBackend, setStreamTimeCharacteristic, socketTextStream, socketTextStream, socketTextStream, socketTextStream, socketTextStream

Methods inherited from class java.lang.Object

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

Constructor Detail

TestStreamEnvironment

public TestStreamEnvironment(JobExecutor jobExecutor,
                             int parallelism,
                             Collection<Path> jarFiles,
                             Collection<URL> classPaths)

TestStreamEnvironment

public TestStreamEnvironment(JobExecutor jobExecutor,
                             int parallelism)

Method Detail

execute

public JobExecutionResult execute(StreamGraph streamGraph)
                           throws Exception

Description copied from class: StreamExecutionEnvironment

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 or forwarding them to a message queue.

Overrides:

execute in class StreamExecutionEnvironment

Parameters:

streamGraph - the stream graph representing the transformations

Returns:

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

Throws:

Exception - which occurs during job execution.

setAsContext

public static void setAsContext(JobExecutor jobExecutor,
                                int parallelism,
                                Collection<Path> jarFiles,
                                Collection<URL> classpaths)

Sets the streaming context environment to a TestStreamEnvironment that runs its programs on the given cluster with the given default parallelism and the specified jar files and class paths.

Parameters:

jobExecutor - The executor to execute the jobs on

parallelism - The default parallelism for the test programs.

jarFiles - Additional jar files to execute the job with

classpaths - Additional class paths to execute the job with

setAsContext

public static void setAsContext(JobExecutor jobExecutor,
                                int parallelism)

Sets the streaming context environment to a TestStreamEnvironment that runs its programs on the given cluster with the given default parallelism.

Parameters:

jobExecutor - The executor to execute the jobs on

parallelism - The default parallelism for the test programs.

unsetAsContext

public static void unsetAsContext()

Resets the streaming context environment to null.