org.apache.flink.streaming.api.scala

Class StreamExecutionEnvironment$

java.lang.Object

org.apache.flink.streaming.api.scala.StreamExecutionEnvironment$

public class StreamExecutionEnvironment$
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static StreamExecutionEnvironment$	MODULE$ Static reference to the singleton instance of this Scala object.

Constructor Summary

Constructors

Constructor and Description
StreamExecutionEnvironment$()

Method Summary

Modifier and Type	Method and Description
StreamExecutionEnvironment	createLocalEnvironment(int parallelism) Creates a local execution environment.
StreamExecutionEnvironment	createRemoteEnvironment(String host, int port, int parallelism, scala.collection.Seq<String> jarFiles) Creates a remote execution environment.
StreamExecutionEnvironment	createRemoteEnvironment(String host, int port, scala.collection.Seq<String> jarFiles) Creates a remote execution environment.
StreamExecutionEnvironment	getExecutionEnvironment() Creates an execution environment that represents the context in which the program is currently executed.
void	setDefaultLocalParallelism(int parallelism) Sets the default parallelism that will be used for the local execution environment created by createLocalEnvironment().

Methods inherited from class java.lang.Object

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

Field Detail

MODULE$

public static final StreamExecutionEnvironment$ MODULE$

Static reference to the singleton instance of this Scala object.

Constructor Detail

StreamExecutionEnvironment$

public StreamExecutionEnvironment$()

Method Detail

setDefaultLocalParallelism

public void setDefaultLocalParallelism(int parallelism)

Sets the default parallelism that will be used for the local execution environment created by createLocalEnvironment().

Parameters:

parallelism - The parallelism to use as the default local parallelism.

getExecutionEnvironment

public StreamExecutionEnvironment getExecutionEnvironment()

Creates an execution environment that represents the context in which the program is currently executed. If the program is invoked standalone, this method returns a local execution environment. If the program is invoked from within the command line client to be submitted to a cluster, this method returns the execution environment of this cluster.

createLocalEnvironment

public StreamExecutionEnvironment createLocalEnvironment(int parallelism)

Creates a local execution environment. The local execution environment will run the program in a multi-threaded fashion in the same JVM as the environment was created in. The default degree of parallelism of the local environment is the number of hardware contexts (CPU cores/threads).

createRemoteEnvironment

public StreamExecutionEnvironment createRemoteEnvironment(String host,
                                                          int port,
                                                          scala.collection.Seq<String> jarFiles)

Creates a remote execution environment. The remote environment sends (parts of) the program to a cluster for execution. Note that all file paths used in the program must be accessible from the cluster. The execution will use the cluster's default parallelism, unless the parallelism is set explicitly via StreamExecutionEnvironment.setParallelism().

Parameters:

host - The host name or address of the master (JobManager), where the program should be executed.

port - The port of the master (JobManager), where the program should be executed.

jarFiles - The JAR files with code that needs to be shipped to the cluster. If the program uses user-defined functions, user-defined input formats, or any libraries, those must be provided in the JAR files.

createRemoteEnvironment

public StreamExecutionEnvironment createRemoteEnvironment(String host,
                                                          int port,
                                                          int parallelism,
                                                          scala.collection.Seq<String> jarFiles)

Creates a remote execution environment. The remote environment sends (parts of) the program to a cluster for execution. Note that all file paths used in the program must be accessible from the cluster. The execution will use the specified parallelism.

Parameters:

host - The host name or address of the master (JobManager), where the program should be executed.

port - The port of the master (JobManager), where the program should be executed.

parallelism - The parallelism to use during the execution.

jarFiles - The JAR files with code that needs to be shipped to the cluster. If the program uses user-defined functions, user-defined input formats, or any libraries, those must be provided in the JAR files.