org.apache.flink.client.deployment.executors

Class LocalExecutor

java.lang.Object

org.apache.flink.client.deployment.executors.LocalExecutor

All Implemented Interfaces:

PipelineExecutor

@Internal
public class LocalExecutor
extends Object
implements PipelineExecutor

An PipelineExecutor for executing a Pipeline locally.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Method Summary

Modifier and Type	Method and Description
static LocalExecutor	create(Configuration configuration)
static LocalExecutor	createWithFactory(Configuration configuration, Function<MiniClusterConfiguration,MiniCluster> miniClusterFactory)
CompletableFuture<JobClient>	execute(Pipeline pipeline, Configuration configuration, ClassLoader userCodeClassloader) Executes a Pipeline based on the provided configuration and returns a JobClient which allows to interact with the job being executed, e.g. cancel it or take a savepoint.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Method Detail

create

public static LocalExecutor create(Configuration configuration)

createWithFactory

public static LocalExecutor createWithFactory(Configuration configuration,
                                              Function<MiniClusterConfiguration,MiniCluster> miniClusterFactory)

execute

public CompletableFuture<JobClient> execute(Pipeline pipeline,
                                            Configuration configuration,
                                            ClassLoader userCodeClassloader)
                                     throws Exception

Description copied from interface: PipelineExecutor

Executes a Pipeline based on the provided configuration and returns a JobClient which allows to interact with the job being executed, e.g. cancel it or take a savepoint.

ATTENTION: The caller is responsible for managing the lifecycle of the returned JobClient. This means that e.g. close() should be called explicitly at the call-site.

Specified by:

execute in interface PipelineExecutor

Parameters:

pipeline - the Pipeline to execute

configuration - the Configuration with the required execution parameters

userCodeClassloader - the ClassLoader to deserialize usercode

Returns:

a CompletableFuture with the JobClient corresponding to the pipeline.

Throws:

Exception