org.apache.flink.streaming.api.environment

Class RemoteStreamEnvironment

java.lang.Object

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

org.apache.flink.streaming.api.environment.RemoteStreamEnvironment

@Public
public class RemoteStreamEnvironment
extends StreamExecutionEnvironment

A StreamExecutionEnvironment for executing on a cluster.

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
RemoteStreamEnvironment(String host, int port, org.apache.flink.configuration.Configuration clientConfiguration, String... jarFiles) Creates a new RemoteStreamEnvironment that points to the master (JobManager) described by the given host name and port.
RemoteStreamEnvironment(String host, int port, org.apache.flink.configuration.Configuration clientConfiguration, String[] jarFiles, URL[] globalClasspaths) Creates a new RemoteStreamEnvironment that points to the master (JobManager) described by the given host name and port.
RemoteStreamEnvironment(String host, int port, String... jarFiles) Creates a new RemoteStreamEnvironment that points to the master (JobManager) described by the given host name and port.

Method Summary

Modifier and Type	Method and Description
org.apache.flink.api.common.JobExecutionResult	execute(String jobName) Triggers the program execution.
protected org.apache.flink.api.common.JobExecutionResult	executeRemotely(StreamGraph streamGraph, List<URL> jarFiles) Executes the remote job.
org.apache.flink.configuration.Configuration	getClientConfiguration()
String	getHost() Gets the hostname of the master (JobManager), where the program will be executed.
int	getPort() Gets the port of the master (JobManager), where the program will be executed.
String	toString()

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

addDefaultKryoSerializer, addDefaultKryoSerializer, addOperator, addSource, addSource, addSource, addSource, clean, createInput, createInput, createLocalEnvironment, createLocalEnvironment, createLocalEnvironment, createLocalEnvironmentWithWebUI, createRemoteEnvironment, createRemoteEnvironment, createRemoteEnvironment, disableOperatorChaining, enableCheckpointing, enableCheckpointing, enableCheckpointing, enableCheckpointing, execute, fromCollection, fromCollection, fromCollection, fromCollection, fromElements, fromElements, fromParallelCollection, fromParallelCollection, generateSequence, getBufferTimeout, getCachedFiles, getCheckpointConfig, getCheckpointingMode, getCheckpointInterval, getConfig, getDefaultLocalParallelism, getExecutionEnvironment, getExecutionPlan, getMaxParallelism, getNumberOfExecutionRetries, getParallelism, getRestartStrategy, getStateBackend, getStreamGraph, getStreamTimeCharacteristic, initializeContextEnvironment, isChainingEnabled, isForceCheckpointing, readFile, readFile, readFile, readFile, readFileStream, readTextFile, readTextFile, registerCachedFile, registerCachedFile, registerType, registerTypeWithKryoSerializer, registerTypeWithKryoSerializer, resetContextEnvironment, setBufferTimeout, setDefaultLocalParallelism, setMaxParallelism, setNumberOfExecutionRetries, setParallelism, setRestartStrategy, setStateBackend, setStateBackend, setStreamTimeCharacteristic, socketTextStream, socketTextStream, socketTextStream, socketTextStream, socketTextStream

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteStreamEnvironment

public RemoteStreamEnvironment(String host,
                               int port,
                               String... jarFiles)

Creates a new RemoteStreamEnvironment that points to the master (JobManager) described by the given host name and port.

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.

RemoteStreamEnvironment

public RemoteStreamEnvironment(String host,
                               int port,
                               org.apache.flink.configuration.Configuration clientConfiguration,
                               String... jarFiles)

Creates a new RemoteStreamEnvironment that points to the master (JobManager) described by the given host name and port.

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 - The configuration used to parametrize the client that connects to the remote cluster.

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.

RemoteStreamEnvironment

public RemoteStreamEnvironment(String host,
                               int port,
                               org.apache.flink.configuration.Configuration clientConfiguration,
                               String[] jarFiles,
                               URL[] globalClasspaths)

Creates a new RemoteStreamEnvironment that points to the master (JobManager) described by the given host name and port.

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 - The configuration used to parametrize the client that connects to the remote cluster.

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.

globalClasspaths - The paths of directories and JAR files that are added to each user code classloader on all nodes in the cluster. Note that the paths must specify a protocol (e.g. file://) and be accessible on all nodes (e.g. by means of a NFS share). The protocol must be supported by the URLClassLoader.

Method Detail

execute

public org.apache.flink.api.common.JobExecutionResult execute(String jobName)
                                                       throws org.apache.flink.client.program.ProgramInvocationException

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

Specified by:

execute in class StreamExecutionEnvironment

Parameters:

jobName - Desired name of the job

Returns:

The result of the job execution, containing elapsed time and accumulators.

Throws:

org.apache.flink.client.program.ProgramInvocationException

executeRemotely

protected org.apache.flink.api.common.JobExecutionResult executeRemotely(StreamGraph streamGraph,
                                                                         List<URL> jarFiles)
                                                                  throws org.apache.flink.client.program.ProgramInvocationException

Executes the remote job.

Parameters:

streamGraph - Stream Graph to execute

jarFiles - List of jar file URLs to ship to the cluster

Returns:

The result of the job execution, containing elapsed time and accumulators.

Throws:

org.apache.flink.client.program.ProgramInvocationException

toString

public String toString()

Overrides:

toString in class Object

getHost

public String getHost()

Gets the hostname of the master (JobManager), where the program will be executed.

Returns:

The hostname of the master

getPort

public int getPort()

Gets the port of the master (JobManager), where the program will be executed.

Returns:

The port of the master

getClientConfiguration

public org.apache.flink.configuration.Configuration getClientConfiguration()