org.apache.flink.client.program

Class StreamPlanEnvironment

java.lang.Object

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

org.apache.flink.client.program.StreamPlanEnvironment

All Implemented Interfaces:

AutoCloseable

@PublicEvolving
public class StreamPlanEnvironment
extends StreamExecutionEnvironment

A special StreamExecutionEnvironment that is used in the web frontend when generating a user-inspectable graph of a streaming job.

Field Summary

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

cacheFile, checkpointCfg, config, configuration, DEFAULT_JOB_NAME, isChainingEnabled, transformations

Constructor Summary

Constructors

Constructor and Description
StreamPlanEnvironment(Configuration configuration, ClassLoader userClassLoader, int parallelism)

Method Summary

Modifier and Type	Method and Description
JobClient	executeAsync(StreamGraph streamGraph) Triggers the program execution asynchronously.
Pipeline	getPipeline()
void	setAsContext()
void	unsetAsContext()

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

addDefaultKryoSerializer, addDefaultKryoSerializer, 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, enableCheckpointing, execute, execute, execute, executeAsync, executeAsync, fromCollection, fromCollection, fromCollection, fromCollection, fromElements, fromElements, fromParallelCollection, fromParallelCollection, fromSequence, fromSource, fromSource, generateSequence, generateStreamGraph, getBufferTimeout, getCachedFiles, getCheckpointConfig, getCheckpointingMode, getCheckpointInterval, getConfig, getConfiguration, getDefaultLocalParallelism, getDefaultSavepointDirectory, getExecutionEnvironment, getExecutionEnvironment, getExecutionPlan, getJobListeners, getMaxParallelism, getNumberOfExecutionRetries, getParallelism, getRestartStrategy, getStateBackend, getStreamGraph, getStreamGraph, getStreamTimeCharacteristic, getTransformations, getUserClassloader, initializeContextEnvironment, invalidateClusterDataset, isChainingEnabled, isChangelogStateBackendEnabled, isForceCheckpointing, isForceUnalignedCheckpoints, isUnalignedCheckpointsEnabled, listCompletedClusterDatasets, readFile, readFile, readFile, readFile, readFileStream, readTextFile, readTextFile, registerCachedFile, registerCachedFile, registerCacheTransformation, registerCollectIterator, registerJobListener, registerSlotSharingGroup, registerType, registerTypeWithKryoSerializer, registerTypeWithKryoSerializer, resetContextEnvironment, setBufferTimeout, setDefaultLocalParallelism, setDefaultSavepointDirectory, setDefaultSavepointDirectory, setDefaultSavepointDirectory, setMaxParallelism, setNumberOfExecutionRetries, setParallelism, setRestartStrategy, setRuntimeMode, 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

StreamPlanEnvironment

public StreamPlanEnvironment(Configuration configuration,
                             ClassLoader userClassLoader,
                             int parallelism)

Method Detail

getPipeline

public Pipeline getPipeline()

executeAsync

public JobClient executeAsync(StreamGraph streamGraph)

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.

setAsContext

public void setAsContext()

unsetAsContext

public void unsetAsContext()