org.apache.flink.client.program

Class StreamContextEnvironment

java.lang.Object

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

org.apache.flink.client.program.StreamContextEnvironment

All Implemented Interfaces:

AutoCloseable

@PublicEvolving
public class StreamContextEnvironment
extends StreamExecutionEnvironment

Special StreamExecutionEnvironment that will be used in cases where the CLI client or testing utilities create a StreamExecutionEnvironment that should be used when StreamExecutionEnvironment.getExecutionEnvironment() is called.

Field Summary

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

cacheFile, checkpointCfg, config, configuration, DEFAULT_JOB_NAME, transformations

Constructor Summary

Constructors

Constructor and Description
StreamContextEnvironment(PipelineExecutorServiceLoader executorServiceLoader, Configuration configuration, ClassLoader userCodeClassLoader, boolean enforceSingleJobExecution, boolean suppressSysout)
StreamContextEnvironment(PipelineExecutorServiceLoader executorServiceLoader, Configuration clusterConfiguration, Configuration configuration, ClassLoader userCodeClassLoader, boolean enforceSingleJobExecution, boolean suppressSysout, boolean programConfigEnabled, Collection<String> programConfigWildcards)

Method Summary

Modifier and Type	Method and Description
JobExecutionResult	execute(StreamGraph streamGraph) Triggers the program execution.
JobClient	executeAsync(StreamGraph streamGraph) Triggers the program execution asynchronously.
static void	setAsContext(PipelineExecutorServiceLoader executorServiceLoader, Configuration clusterConfiguration, ClassLoader userCodeClassLoader, boolean enforceSingleJobExecution, boolean suppressSysout)
static void	unsetAsContext()

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

addOperator, addSource, addSource, addSource, addSource, areExplicitEnvironmentsAllowed, clean, clearJobListeners, close, configure, configure, createInput, createInput, createLocalEnvironment, createLocalEnvironment, createLocalEnvironment, createLocalEnvironment, createLocalEnvironmentWithWebUI, createRemoteEnvironment, createRemoteEnvironment, createRemoteEnvironment, disableOperatorChaining, enableChangelogStateBackend, enableCheckpointing, enableCheckpointing, enableCheckpointing, execute, execute, executeAsync, executeAsync, fromCollection, fromCollection, fromCollection, fromCollection, fromData, fromData, fromData, fromData, fromData, fromElements, fromElements, fromParallelCollection, fromParallelCollection, fromSequence, fromSource, fromSource, generateSequence, generateStreamGraph, getBufferTimeout, getCachedFiles, getCheckpointConfig, getCheckpointingConsistencyMode, getCheckpointingMode, getCheckpointInterval, getConfig, getConfiguration, getDefaultLocalParallelism, getDefaultSavepointDirectory, getExecutionEnvironment, getExecutionEnvironment, getExecutionPlan, getJobListeners, getMaxParallelism, getParallelism, getStreamGraph, getStreamGraph, getStreamTimeCharacteristic, getTransformations, getUserClassloader, initializeContextEnvironment, invalidateClusterDataset, isChainingEnabled, isChainingOfOperatorsWithDifferentMaxParallelismEnabled, isChangelogStateBackendEnabled, isForceUnalignedCheckpoints, isUnalignedCheckpointsEnabled, listCompletedClusterDatasets, readFile, readFile, readFile, readFile, readFileStream, readTextFile, readTextFile, registerCachedFile, registerCachedFile, registerCacheTransformation, registerCollectIterator, registerJobListener, registerSlotSharingGroup, resetContextEnvironment, setBufferTimeout, setDefaultLocalParallelism, setDefaultSavepointDirectory, setDefaultSavepointDirectory, setDefaultSavepointDirectory, setMaxParallelism, setParallelism, setRuntimeMode, 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

StreamContextEnvironment

public StreamContextEnvironment(PipelineExecutorServiceLoader executorServiceLoader,
                                Configuration configuration,
                                ClassLoader userCodeClassLoader,
                                boolean enforceSingleJobExecution,
                                boolean suppressSysout)

StreamContextEnvironment

@Internal
public StreamContextEnvironment(PipelineExecutorServiceLoader executorServiceLoader,
                                          Configuration clusterConfiguration,
                                          Configuration configuration,
                                          ClassLoader userCodeClassLoader,
                                          boolean enforceSingleJobExecution,
                                          boolean suppressSysout,
                                          boolean programConfigEnabled,
                                          Collection<String> programConfigWildcards)

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.

executeAsync

public JobClient executeAsync(StreamGraph streamGraph)
                       throws Exception

Description copied from class: StreamExecutionEnvironment

Triggers the program execution asynchronously. 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:

executeAsync in class StreamExecutionEnvironment

Parameters:

streamGraph - the stream graph representing the transformations

Returns:

A JobClient that can be used to communicate with the submitted job, completed on submission succeeded.

Throws:

Exception - which occurs during job execution.

setAsContext

public static void setAsContext(PipelineExecutorServiceLoader executorServiceLoader,
                                Configuration clusterConfiguration,
                                ClassLoader userCodeClassLoader,
                                boolean enforceSingleJobExecution,
                                boolean suppressSysout)

unsetAsContext

public static void unsetAsContext()