DummyStreamExecutionEnvironment (flink 1.10-SNAPSHOT API)

java.lang.Object
- org.apache.flink.streaming.api.environment.StreamExecutionEnvironment
- - org.apache.flink.table.planner.utils.DummyStreamExecutionEnvironment

```
public class DummyStreamExecutionEnvironment
extends StreamExecutionEnvironment
```
This is dummy StreamExecutionEnvironment, only used for Planner.explain(List, boolean) method.
Transformations will be added into a StreamExecutionEnvironment when translating ExecNode to plan, and they will be cleared only when calling StreamExecutionEnvironment.execute() method.
Planner.explain(List, boolean) method will not only print logical plan but also execution plan, translating will happen in explain method. If calling explain method before execute method, the transformations in StreamExecutionEnvironment is dirty, and execution result may be incorrect.
All set methods (e.g. `setXX`, `enableXX`, `disableXX`, etc) are disabled to prohibit changing configuration, all get methods (e.g. `getXX`, `isXX`, etc) will be delegated to real StreamExecutionEnvironment. `execute`, `getStreamGraph`, `getExecutionPlan` methods are also disabled, while `addOperator` method is enabled to let `explain` method add Transformations to this StreamExecutionEnvironment.
This class could be removed once the TableSource interface and StreamTableSink interface are reworked.
NOTE: Please remove com.esotericsoftware.kryo item in the whitelist of checkCodeDependencies() method in test_table_shaded_dependencies.sh end-to-end test when this class is removed.

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

DummyStreamExecutionEnvironment(StreamExecutionEnvironment realExecEnv)

Constructors
Constructor and Description
`DummyStreamExecutionEnvironment(StreamExecutionEnvironment realExecEnv)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDefaultKryoSerializer(Class<?> type, Class<? extends com.esotericsoftware.kryo.Serializer<?>> serializerClass)` Adds a new Kryo default serializer to the Runtime.
`<T extends com.esotericsoftware.kryo.Serializer<?> & Serializable> void`	`addDefaultKryoSerializer(Class<?> type, T serializer)` Adds a new Kryo default serializer to the Runtime.
`StreamExecutionEnvironment`	`disableOperatorChaining()` Disables operator chaining for streaming operators.
`StreamExecutionEnvironment`	`enableCheckpointing()` Enables checkpointing for the streaming job.
`StreamExecutionEnvironment`	`enableCheckpointing(long interval)` Enables checkpointing for the streaming job.
`StreamExecutionEnvironment`	`enableCheckpointing(long interval, CheckpointingMode mode)` Enables checkpointing for the streaming job.
`StreamExecutionEnvironment`	`enableCheckpointing(long interval, CheckpointingMode mode, boolean force)` Enables checkpointing for the streaming job.
`JobExecutionResult`	`execute()` Triggers the program execution.
`JobExecutionResult`	`execute(StreamGraph streamGraph)` Triggers the program execution.
`JobExecutionResult`	`execute(String jobName)` Triggers the program execution.
`long`	`getBufferTimeout()` Gets the maximum time frequency (milliseconds) for the flushing of the output buffers.
`List<Tuple2<String,DistributedCache.DistributedCacheEntry>>`	`getCachedFiles()` Get the list of cached files that were registered for distribution among the task managers.
`CheckpointConfig`	`getCheckpointConfig()` Gets the checkpoint config, which defines values like checkpoint interval, delay between checkpoints, etc.
`CheckpointingMode`	`getCheckpointingMode()` Returns the checkpointing mode (exactly-once vs.
`long`	`getCheckpointInterval()` Returns the checkpointing interval or -1 if checkpointing is disabled.
`ExecutionConfig`	`getConfig()` Gets the config object.
`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.
`int`	`getMaxParallelism()` Gets the maximum degree of parallelism defined for the program.
`int`	`getNumberOfExecutionRetries()` Gets the number of times the system will try to re-execute failed tasks.
`int`	`getParallelism()` Gets the parallelism with which operation are executed by default.
`RestartStrategies.RestartStrategyConfiguration`	`getRestartStrategy()` Returns the specified restart strategy configuration.
`StateBackend`	`getStateBackend()` Gets the state backend that defines how to store and checkpoint state.
`StreamGraph`	`getStreamGraph()` Getter of the `StreamGraph` of the streaming job.
`StreamGraph`	`getStreamGraph(String jobName)` Getter of the `StreamGraph` of the streaming job.
`TimeCharacteristic`	`getStreamTimeCharacteristic()` Gets the time characteristic.
`boolean`	`isChainingEnabled()` Returns whether operator chaining is enabled.
`boolean`	`isForceCheckpointing()` Returns whether checkpointing is force-enabled.
`void`	`registerCachedFile(String filePath, String name)` Registers a file at the distributed cache under the given name.
`void`	`registerCachedFile(String filePath, String name, boolean executable)` Registers a file at the distributed cache under the given name.
`void`	`registerType(Class<?> type)` Registers the given type with the serialization stack.
`void`	`registerTypeWithKryoSerializer(Class<?> type, Class<? extends com.esotericsoftware.kryo.Serializer> serializerClass)` Registers the given Serializer via its class as a serializer for the given type at the KryoSerializer.
`<T extends com.esotericsoftware.kryo.Serializer<?> & Serializable> void`	`registerTypeWithKryoSerializer(Class<?> type, T serializer)` Registers the given type with a Kryo Serializer.
`StreamExecutionEnvironment`	`setBufferTimeout(long timeoutMillis)` Sets the maximum time frequency (milliseconds) for the flushing of the output buffers.
`StreamExecutionEnvironment`	`setMaxParallelism(int maxParallelism)` Sets the maximum degree of parallelism defined for the program.
`void`	`setNumberOfExecutionRetries(int numberOfExecutionRetries)` Sets the number of times that failed tasks are re-executed.
`StreamExecutionEnvironment`	`setParallelism(int parallelism)` Sets the parallelism for operations executed through this environment.
`void`	`setRestartStrategy(RestartStrategies.RestartStrategyConfiguration restartStrategyConfiguration)` Sets the restart strategy configuration.
`StreamExecutionEnvironment`	`setStateBackend(AbstractStateBackend backend)`
`StreamExecutionEnvironment`	`setStateBackend(StateBackend backend)` Sets the state backend that describes how to store and checkpoint operator state.
`void`	`setStreamTimeCharacteristic(TimeCharacteristic characteristic)` Sets the time characteristic for all streams create from this environment, e.g., processing time, event time, or ingestion time.

Methods inherited from class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment
addOperator, addSource, addSource, addSource, addSource, clean, clearJobListeners, configure, createInput, createInput, createLocalEnvironment, createLocalEnvironment, createLocalEnvironment, createLocalEnvironmentWithWebUI, createRemoteEnvironment, createRemoteEnvironment, createRemoteEnvironment, executeAsync, executeAsync, executeAsync, fromCollection, fromCollection, fromCollection, fromCollection, fromElements, fromElements, fromParallelCollection, fromParallelCollection, generateSequence, getConfiguration, getDefaultLocalParallelism, getExecutionEnvironment, getJobListeners, getStreamGraph, initializeContextEnvironment, readFile, readFile, readFile, readFile, readFileStream, readTextFile, readTextFile, registerJobListener, resetContextEnvironment, setDefaultLocalParallelism, 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
  - DummyStreamExecutionEnvironment
```
public DummyStreamExecutionEnvironment(StreamExecutionEnvironment realExecEnv)
```
- Method Detail
  - getConfig
```
public ExecutionConfig getConfig()
```
    Description copied from class: StreamExecutionEnvironment
    
    Gets the config object.
    
    Overrides:
    
    getConfig in class StreamExecutionEnvironment
  - getCachedFiles
```
public List<Tuple2<String,DistributedCache.DistributedCacheEntry>> getCachedFiles()
```
    Description copied from class: StreamExecutionEnvironment
    
    Get the list of cached files that were registered for distribution among the task managers.
    
    Overrides:
    
    getCachedFiles in class StreamExecutionEnvironment
  - setParallelism
```
public StreamExecutionEnvironment setParallelism(int parallelism)
```
    Description copied from class: StreamExecutionEnvironment
    
    Sets the parallelism for operations executed through this environment. Setting a parallelism of x here will cause all operators (such as map, batchReduce) to run with x parallel instances. This method overrides the default parallelism for this environment. The LocalStreamEnvironment uses by default a value equal to the number of hardware contexts (CPU cores / threads). When executing the program via the command line client from a JAR file, the default degree of parallelism is the one configured for that setup.
    
    Overrides:
    
    setParallelism in class StreamExecutionEnvironment
    
    Parameters:
    
    parallelism - The parallelism
  - setMaxParallelism
```
public StreamExecutionEnvironment setMaxParallelism(int maxParallelism)
```
    Description copied from class: StreamExecutionEnvironment
    
    Sets the maximum degree of parallelism defined for the program. The upper limit (inclusive) is Short.MAX_VALUE.
    The maximum degree of parallelism specifies the upper limit for dynamic scaling. It also defines the number of key groups used for partitioned state.
    
    Overrides:
    
    setMaxParallelism in class StreamExecutionEnvironment
    
    Parameters:
    
    maxParallelism - Maximum degree of parallelism to be used for the program., with 0 < maxParallelism <= 2^15 - 1
  - getParallelism
```
public int getParallelism()
```
    Description copied from class: StreamExecutionEnvironment
    
    Gets the parallelism with which operation are executed by default. Operations can individually override this value to use a specific parallelism.
    
    Overrides:
    
    getParallelism in class StreamExecutionEnvironment
    
    Returns:
    
    The parallelism used by operations, unless they override that value.
  - getMaxParallelism
```
public int getMaxParallelism()
```
    Description copied from class: StreamExecutionEnvironment
    
    Gets the maximum degree of parallelism defined for the program.
    The maximum degree of parallelism specifies the upper limit for dynamic scaling. It also defines the number of key groups used for partitioned state.
    
    Overrides:
    
    getMaxParallelism in class StreamExecutionEnvironment
    
    Returns:
    
    Maximum degree of parallelism
  - setBufferTimeout
```
public StreamExecutionEnvironment setBufferTimeout(long timeoutMillis)
```
    Description copied from class: StreamExecutionEnvironment
    Sets the maximum time frequency (milliseconds) for the flushing of the output buffers. By default the output buffers flush frequently to provide low latency and to aid smooth developer experience. Setting the parameter can result in three logical modes:
    - A positive integer triggers flushing periodically by that integer
    - 0 triggers flushing after every record thus minimizing latency
    - -1 triggers flushing only when the output buffer is full thus maximizing throughput
    Overrides:
    
    setBufferTimeout in class StreamExecutionEnvironment
    
    Parameters:
    
    timeoutMillis - The maximum time between two output flushes.
  - getBufferTimeout
```
public long getBufferTimeout()
```
    Description copied from class: StreamExecutionEnvironment
    
    Gets the maximum time frequency (milliseconds) for the flushing of the output buffers. For clarification on the extremal values see StreamExecutionEnvironment.setBufferTimeout(long).
    
    Overrides:
    
    getBufferTimeout in class StreamExecutionEnvironment
    
    Returns:
    
    The timeout of the buffer.
  - disableOperatorChaining
```
public StreamExecutionEnvironment disableOperatorChaining()
```
    Description copied from class: StreamExecutionEnvironment
    
    Disables operator chaining for streaming operators. Operator chaining allows non-shuffle operations to be co-located in the same thread fully avoiding serialization and de-serialization.
    
    Overrides:
    
    disableOperatorChaining in class StreamExecutionEnvironment
    
    Returns:
    
    StreamExecutionEnvironment with chaining disabled.
  - isChainingEnabled
```
public boolean isChainingEnabled()
```
    Description copied from class: StreamExecutionEnvironment
    
    Returns whether operator chaining is enabled.
    
    Overrides:
    
    isChainingEnabled in class StreamExecutionEnvironment
    
    Returns:
    
    true if chaining is enabled, false otherwise.
  - getCheckpointConfig
```
public CheckpointConfig getCheckpointConfig()
```
    Description copied from class: StreamExecutionEnvironment
    
    Gets the checkpoint config, which defines values like checkpoint interval, delay between checkpoints, etc.
    
    Overrides:
    
    getCheckpointConfig in class StreamExecutionEnvironment
    
    Returns:
    
    The checkpoint config.
  - enableCheckpointing
```
public StreamExecutionEnvironment enableCheckpointing(long interval)
```
    Description copied from class: StreamExecutionEnvironment
    
    Enables checkpointing for the streaming job. The distributed state of the streaming dataflow will be periodically snapshotted. In case of a failure, the streaming dataflow will be restarted from the latest completed checkpoint. This method selects CheckpointingMode.EXACTLY_ONCE guarantees.
    The job draws checkpoints periodically, in the given interval. The state will be stored in the configured state backend.
    NOTE: Checkpointing iterative streaming dataflows in not properly supported at the moment. For that reason, iterative jobs will not be started if used with enabled checkpointing. To override this mechanism, use the StreamExecutionEnvironment.enableCheckpointing(long, CheckpointingMode, boolean) method.
    
    Overrides:
    
    enableCheckpointing in class StreamExecutionEnvironment
    
    Parameters:
    
    interval - Time interval between state checkpoints in milliseconds.
  - enableCheckpointing
```
public StreamExecutionEnvironment enableCheckpointing(long interval,
                                                      CheckpointingMode mode)
```
    Description copied from class: StreamExecutionEnvironment
    
    Enables checkpointing for the streaming job. The distributed state of the streaming dataflow will be periodically snapshotted. In case of a failure, the streaming dataflow will be restarted from the latest completed checkpoint.
    The job draws checkpoints periodically, in the given interval. The system uses the given CheckpointingMode for the checkpointing ("exactly once" vs "at least once"). The state will be stored in the configured state backend.
    NOTE: Checkpointing iterative streaming dataflows in not properly supported at the moment. For that reason, iterative jobs will not be started if used with enabled checkpointing. To override this mechanism, use the StreamExecutionEnvironment.enableCheckpointing(long, CheckpointingMode, boolean) method.
    
    Overrides:
    
    enableCheckpointing in class StreamExecutionEnvironment
    
    Parameters:
    
    interval - Time interval between state checkpoints in milliseconds.
    
    mode - The checkpointing mode, selecting between "exactly once" and "at least once" guaranteed.
  - enableCheckpointing
```
public StreamExecutionEnvironment enableCheckpointing(long interval,
                                                      CheckpointingMode mode,
                                                      boolean force)
```
    Description copied from class: StreamExecutionEnvironment
    
    Enables checkpointing for the streaming job. The distributed state of the streaming dataflow will be periodically snapshotted. In case of a failure, the streaming dataflow will be restarted from the latest completed checkpoint.
    The job draws checkpoints periodically, in the given interval. The state will be stored in the configured state backend.
    NOTE: Checkpointing iterative streaming dataflows in not properly supported at the moment. If the "force" parameter is set to true, the system will execute the job nonetheless.
    
    Overrides:
    
    enableCheckpointing in class StreamExecutionEnvironment
    
    Parameters:
    
    interval - Time interval between state checkpoints in millis.
    
    mode - The checkpointing mode, selecting between "exactly once" and "at least once" guaranteed.
    
    force - If true checkpointing will be enabled for iterative jobs as well.
  - enableCheckpointing
```
public StreamExecutionEnvironment enableCheckpointing()
```
    Description copied from class: StreamExecutionEnvironment
    
    Enables checkpointing for the streaming job. The distributed state of the streaming dataflow will be periodically snapshotted. In case of a failure, the streaming dataflow will be restarted from the latest completed checkpoint. This method selects CheckpointingMode.EXACTLY_ONCE guarantees.
    The job draws checkpoints periodically, in the default interval. The state will be stored in the configured state backend.
    NOTE: Checkpointing iterative streaming dataflows in not properly supported at the moment. For that reason, iterative jobs will not be started if used with enabled checkpointing. To override this mechanism, use the StreamExecutionEnvironment.enableCheckpointing(long, CheckpointingMode, boolean) method.
    
    Overrides:
    
    enableCheckpointing in class StreamExecutionEnvironment
  - getCheckpointInterval
```
public long getCheckpointInterval()
```
    Description copied from class: StreamExecutionEnvironment
    
    Returns the checkpointing interval or -1 if checkpointing is disabled.
    Shorthand for getCheckpointConfig().getCheckpointInterval().
    
    Overrides:
    
    getCheckpointInterval in class StreamExecutionEnvironment
    
    Returns:
    
    The checkpointing interval or -1
  - isForceCheckpointing
```
public boolean isForceCheckpointing()
```
    Description copied from class: StreamExecutionEnvironment
    
    Returns whether checkpointing is force-enabled.
    
    Overrides:
    
    isForceCheckpointing in class StreamExecutionEnvironment
  - getCheckpointingMode
```
public CheckpointingMode getCheckpointingMode()
```
    Description copied from class: StreamExecutionEnvironment
    
    Returns the checkpointing mode (exactly-once vs. at-least-once).
    Shorthand for getCheckpointConfig().getCheckpointingMode().
    
    Overrides:
    
    getCheckpointingMode in class StreamExecutionEnvironment
    
    Returns:
    
    The checkpoint mode
  - setStateBackend
```
public StreamExecutionEnvironment setStateBackend(StateBackend backend)
```
    Description copied from class: StreamExecutionEnvironment
    
    Sets the state backend that describes how to store and checkpoint operator state. It defines both which data structures hold state during execution (for example hash tables, RockDB, or other data stores) as well as where checkpointed data will be persisted.
    State managed by the state backend includes both keyed state that is accessible on keyed streams, as well as state maintained directly by the user code that implements CheckpointedFunction.
    The MemoryStateBackend for example maintains the state in heap memory, as objects. It is lightweight without extra dependencies, but can checkpoint only small states (some counters).
    In contrast, the FsStateBackend stores checkpoints of the state (also maintained as heap objects) in files. When using a replicated file system (like HDFS, S3, MapR FS, Alluxio, etc) this will guarantee that state is not lost upon failures of individual nodes and that streaming program can be executed highly available and strongly consistent (assuming that Flink is run in high-availability mode).
    
    Overrides:
    
    setStateBackend in class StreamExecutionEnvironment
    
    Returns:
    
    This StreamExecutionEnvironment itself, to allow chaining of function calls.
    
    See Also:
    
    StreamExecutionEnvironment.getStateBackend()
  - setStateBackend
```
public StreamExecutionEnvironment setStateBackend(AbstractStateBackend backend)
```
    Overrides:
    
    setStateBackend in class StreamExecutionEnvironment
  - getStateBackend
```
public StateBackend getStateBackend()
```
    Description copied from class: StreamExecutionEnvironment
    
    Gets the state backend that defines how to store and checkpoint state.
    
    Overrides:
    
    getStateBackend in class StreamExecutionEnvironment
    
    See Also:
    
    StreamExecutionEnvironment.setStateBackend(StateBackend)
  - setRestartStrategy
```
public void setRestartStrategy(RestartStrategies.RestartStrategyConfiguration restartStrategyConfiguration)
```
    Description copied from class: StreamExecutionEnvironment
    
    Sets the restart strategy configuration. The configuration specifies which restart strategy will be used for the execution graph in case of a restart.
    
    Overrides:
    
    setRestartStrategy in class StreamExecutionEnvironment
    
    Parameters:
    
    restartStrategyConfiguration - Restart strategy configuration to be set
  - getRestartStrategy
```
public RestartStrategies.RestartStrategyConfiguration getRestartStrategy()
```
    Description copied from class: StreamExecutionEnvironment
    
    Returns the specified restart strategy configuration.
    
    Overrides:
    
    getRestartStrategy in class StreamExecutionEnvironment
    
    Returns:
    
    The restart strategy configuration to be used
  - setNumberOfExecutionRetries
```
public void setNumberOfExecutionRetries(int numberOfExecutionRetries)
```
    Description copied from class: StreamExecutionEnvironment
    
    Sets the number of times that failed tasks are re-executed. A value of zero effectively disables fault tolerance. A value of -1 indicates that the system default value (as defined in the configuration) should be used.
    
    Overrides:
    
    setNumberOfExecutionRetries in class StreamExecutionEnvironment
    
    Parameters:
    
    numberOfExecutionRetries - The number of times the system will try to re-execute failed tasks.
  - getNumberOfExecutionRetries
```
public int getNumberOfExecutionRetries()
```
    Description copied from class: StreamExecutionEnvironment
    
    Gets the number of times the system will try to re-execute failed tasks. A value of -1 indicates that the system default value (as defined in the configuration) should be used.
    
    Overrides:
    
    getNumberOfExecutionRetries in class StreamExecutionEnvironment
    
    Returns:
    
    The number of times the system will try to re-execute failed tasks.
  - addDefaultKryoSerializer
```
public <T extends com.esotericsoftware.kryo.Serializer<?> & Serializable> void addDefaultKryoSerializer(Class<?> type,
                                                                                                        T serializer)
```
    Description copied from class: StreamExecutionEnvironment
    
    Adds a new Kryo default serializer to the Runtime.
    Note that the serializer instance must be serializable (as defined by java.io.Serializable), because it may be distributed to the worker nodes by java serialization.
    
    Overrides:
    
    addDefaultKryoSerializer in class StreamExecutionEnvironment
    
    Parameters:
    
    type - The class of the types serialized with the given serializer.
    
    serializer - The serializer to use.
  - addDefaultKryoSerializer
```
public void addDefaultKryoSerializer(Class<?> type,
                                     Class<? extends com.esotericsoftware.kryo.Serializer<?>> serializerClass)
```
    Description copied from class: StreamExecutionEnvironment
    
    Adds a new Kryo default serializer to the Runtime.
    
    Overrides:
    
    addDefaultKryoSerializer in class StreamExecutionEnvironment
    
    Parameters:
    
    type - The class of the types serialized with the given serializer.
    
    serializerClass - The class of the serializer to use.
  - registerTypeWithKryoSerializer
```
public <T extends com.esotericsoftware.kryo.Serializer<?> & Serializable> void registerTypeWithKryoSerializer(Class<?> type,
                                                                                                              T serializer)
```
    Description copied from class: StreamExecutionEnvironment
    
    Registers the given type with a Kryo Serializer.
    Note that the serializer instance must be serializable (as defined by java.io.Serializable), because it may be distributed to the worker nodes by java serialization.
    
    Overrides:
    
    registerTypeWithKryoSerializer in class StreamExecutionEnvironment
    
    Parameters:
    
    type - The class of the types serialized with the given serializer.
    
    serializer - The serializer to use.
  - registerTypeWithKryoSerializer
```
public void registerTypeWithKryoSerializer(Class<?> type,
                                           Class<? extends com.esotericsoftware.kryo.Serializer> serializerClass)
```
    Description copied from class: StreamExecutionEnvironment
    
    Registers the given Serializer via its class as a serializer for the given type at the KryoSerializer.
    
    Overrides:
    
    registerTypeWithKryoSerializer in class StreamExecutionEnvironment
    
    Parameters:
    
    type - The class of the types serialized with the given serializer.
    
    serializerClass - The class of the serializer to use.
  - registerType
```
public void registerType(Class<?> type)
```
    Description copied from class: StreamExecutionEnvironment
    
    Registers the given type with the serialization stack. If the type is eventually serialized as a POJO, then the type is registered with the POJO serializer. If the type ends up being serialized with Kryo, then it will be registered at Kryo to make sure that only tags are written.
    
    Overrides:
    
    registerType in class StreamExecutionEnvironment
    
    Parameters:
    
    type - The class of the type to register.
  - setStreamTimeCharacteristic
```
public void setStreamTimeCharacteristic(TimeCharacteristic characteristic)
```
    Description copied from class: StreamExecutionEnvironment
    
    Sets the time characteristic for all streams create from this environment, e.g., processing time, event time, or ingestion time.
    If you set the characteristic to IngestionTime of EventTime this will set a default watermark update interval of 200 ms. If this is not applicable for your application you should change it using ExecutionConfig.setAutoWatermarkInterval(long).
    
    Overrides:
    
    setStreamTimeCharacteristic in class StreamExecutionEnvironment
    
    Parameters:
    
    characteristic - The time characteristic.
  - getStreamTimeCharacteristic
```
public TimeCharacteristic getStreamTimeCharacteristic()
```
    Description copied from class: StreamExecutionEnvironment
    
    Gets the time characteristic.
    
    Overrides:
    
    getStreamTimeCharacteristic in class StreamExecutionEnvironment
    
    Returns:
    
    The time characteristic.
    
    See Also:
    
    StreamExecutionEnvironment.setStreamTimeCharacteristic(org.apache.flink.streaming.api.TimeCharacteristic)
  - execute
```
public JobExecutionResult execute()
                           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.
    The program execution will be logged and displayed with a generated default name.
    
    Overrides:
    
    execute in class StreamExecutionEnvironment
    
    Returns:
    
    The result of the job execution, containing elapsed time and accumulators.
    
    Throws:
    
    Exception - which occurs during job execution.
  - execute
```
public JobExecutionResult execute(String jobName)
                           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.
    The program execution will be logged and displayed with the provided name
    
    Overrides:
    
    execute in class StreamExecutionEnvironment
    
    Parameters:
    
    jobName - Desired name of the job
    
    Returns:
    
    The result of the job execution, containing elapsed time and accumulators.
    
    Throws:
    
    Exception - which occurs during job execution.
  - 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.
  - registerCachedFile
```
public void registerCachedFile(String filePath,
                               String name)
```
    Description copied from class: StreamExecutionEnvironment
    
    Registers a file at the distributed cache under the given name. The file will be accessible from any user-defined function in the (distributed) runtime under a local path. Files may be local files (which will be distributed via BlobServer), or files in a distributed file system. The runtime will copy the files temporarily to a local cache, if needed.
    The RuntimeContext can be obtained inside UDFs via RichFunction.getRuntimeContext() and provides access DistributedCache via RuntimeContext.getDistributedCache().
    
    Overrides:
    
    registerCachedFile in class StreamExecutionEnvironment
    
    Parameters:
    
    filePath - The path of the file, as a URI (e.g. "file:///some/path" or "hdfs://host:port/and/path")
    
    name - The name under which the file is registered.
  - registerCachedFile
```
public void registerCachedFile(String filePath,
                               String name,
                               boolean executable)
```
    Description copied from class: StreamExecutionEnvironment
    
    Registers a file at the distributed cache under the given name. The file will be accessible from any user-defined function in the (distributed) runtime under a local path. Files may be local files (which will be distributed via BlobServer), or files in a distributed file system. The runtime will copy the files temporarily to a local cache, if needed.
    The RuntimeContext can be obtained inside UDFs via RichFunction.getRuntimeContext() and provides access DistributedCache via RuntimeContext.getDistributedCache().
    
    Overrides:
    
    registerCachedFile in class StreamExecutionEnvironment
    
    Parameters:
    
    filePath - The path of the file, as a URI (e.g. "file:///some/path" or "hdfs://host:port/and/path")
    
    name - The name under which the file is registered.
    
    executable - flag indicating whether the file should be executable
  - getStreamGraph
```
public StreamGraph getStreamGraph()
```
    Description copied from class: StreamExecutionEnvironment
    
    Getter of the StreamGraph of the streaming job. This call clears previously registered transformations.
    
    Overrides:
    
    getStreamGraph in class StreamExecutionEnvironment
    
    Returns:
    
    The streamgraph representing the transformations
  - getStreamGraph
```
public StreamGraph getStreamGraph(String jobName)
```
    Description copied from class: StreamExecutionEnvironment
    
    Getter of the StreamGraph of the streaming job. This call clears previously registered transformations.
    
    Overrides:
    
    getStreamGraph in class StreamExecutionEnvironment
    
    Parameters:
    
    jobName - Desired name of the job
    
    Returns:
    
    The streamgraph representing the transformations
  - getExecutionPlan
```
public String getExecutionPlan()
```
    Description copied from class: StreamExecutionEnvironment
    
    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. Note that this needs to be called, before the plan is executed.
    
    Overrides:
    
    getExecutionPlan in class StreamExecutionEnvironment
    
    Returns:
    
    The execution plan of the program, as a JSON String.

Back to Flink Website

Class DummyStreamExecutionEnvironment

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

DummyStreamExecutionEnvironment

Method Detail

getConfig

getCachedFiles

setParallelism

setMaxParallelism

getParallelism

getMaxParallelism

setBufferTimeout

getBufferTimeout

disableOperatorChaining

isChainingEnabled

getCheckpointConfig

enableCheckpointing

enableCheckpointing

enableCheckpointing

enableCheckpointing

getCheckpointInterval

isForceCheckpointing

getCheckpointingMode

setStateBackend

setStateBackend

getStateBackend

setRestartStrategy

getRestartStrategy

setNumberOfExecutionRetries

getNumberOfExecutionRetries

addDefaultKryoSerializer

addDefaultKryoSerializer

registerTypeWithKryoSerializer

registerTypeWithKryoSerializer

registerType

setStreamTimeCharacteristic

getStreamTimeCharacteristic

execute

execute

execute

registerCachedFile

registerCachedFile

getStreamGraph

getStreamGraph

getExecutionPlan