org.apache.flink.api.scala

Class ExecutionEnvironment$

java.lang.Object

org.apache.flink.api.scala.ExecutionEnvironment$

public class ExecutionEnvironment$
extends Object

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ExecutionEnvironment$()

Method Summary

Modifier and Type	Method and Description
ExecutionEnvironment	createCollectionsEnvironment() Creates an execution environment that uses Java Collections underneath.
ExecutionEnvironment	createLocalEnvironment(Configuration customConfiguration) Creates a local execution environment.
ExecutionEnvironment	createLocalEnvironment(int parallelism) Creates a local execution environment.
ExecutionEnvironment	createRemoteEnvironment(String host, int port, Configuration clientConfiguration, scala.collection.Seq<String> jarFiles) Creates a remote execution environment.
ExecutionEnvironment	createRemoteEnvironment(String host, int port, int parallelism, scala.collection.Seq<String> jarFiles) Creates a remote execution environment.
ExecutionEnvironment	createRemoteEnvironment(String host, int port, scala.collection.Seq<String> jarFiles) Creates a remote execution environment.
ExecutionEnvironment	getExecutionEnvironment() Creates an execution environment that represents the context in which the program is currently executed.

Methods inherited from class java.lang.Object

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

Field Detail

MODULE$

public static final ExecutionEnvironment$ MODULE$

Static reference to the singleton instance of this Scala object.

Constructor Detail

ExecutionEnvironment$

public ExecutionEnvironment$()

Method Detail

getExecutionEnvironment

public ExecutionEnvironment 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 ExecutionEnvironment 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 parallelism of the local environment is the number of hardware contexts (CPU cores/threads).

createLocalEnvironment

public ExecutionEnvironment createLocalEnvironment(Configuration customConfiguration)

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. This method allows to pass a custom Configuration to the local environment.

createCollectionsEnvironment

public ExecutionEnvironment createCollectionsEnvironment()

Creates an execution environment that uses Java Collections underneath. This will execute in a single thread in the current JVM. It is very fast but will fail if the data does not fit into memory. This is useful during implementation and for debugging.

Returns:

createRemoteEnvironment

public ExecutionEnvironment 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 ExecutionEnvironment.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 ExecutionEnvironment 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.

createRemoteEnvironment

public ExecutionEnvironment createRemoteEnvironment(String host,
                                                    int port,
                                                    Configuration clientConfiguration,
                                                    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 custom configuration file is used to configure Akka specific configuration parameters for the Client only; Program parallelism can be set via ExecutionEnvironment.setParallelism.

Cluster configuration has to be done in the remotely running Flink instance.

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.

clientConfiguration - Pass a custom configuration to the Client.

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.

Returns:

A remote environment that executes the program on a cluster.