Package org.apache.flink.client.deployment.application.executors

Class EmbeddedExecutor

java.lang.Object

org.apache.flink.client.deployment.application.executors.EmbeddedExecutor

All Implemented Interfaces:

PipelineExecutor

@Internal
public class EmbeddedExecutor
extends Object
implements PipelineExecutor

A base class for executors that invoke directly methods of the Dispatcher and do not go through the REST API.

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME

Constructor Summary

Constructors

Constructor	Description
EmbeddedExecutor(Collection<JobID> submittedJobIds, DispatcherGateway dispatcherGateway, Configuration configuration, EmbeddedJobClientCreator jobClientCreator)	Creates a EmbeddedExecutor.

Method Summary

Modifier and Type	Method	Description
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

Constructor Detail

EmbeddedExecutor

public EmbeddedExecutor(Collection<JobID> submittedJobIds,
                        DispatcherGateway dispatcherGateway,
                        Configuration configuration,
                        EmbeddedJobClientCreator jobClientCreator)

Creates a EmbeddedExecutor.

Parameters:

submittedJobIds - a list that is going to be filled with the job ids of the new jobs that will be submitted. This is essentially used to return the submitted job ids to the caller.

dispatcherGateway - the dispatcher of the cluster which is going to be used to submit jobs.

configuration - the flink application configuration

jobClientCreator - the job client creator

Method Detail

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