alluxio.job.plan

Interface PlanDefinition<T extends JobConfig,P extends java.io.Serializable,R extends java.io.Serializable>

Type Parameters:

T - the job configuration

P - the parameters to pass to each task

R - the return type from the task

All Known Implementing Classes:

AbstractVoidPlanDefinition, BatchedJobDefinition, CompactDefinition, EvictDefinition, LoadDefinition, MigrateDefinition, MoveDefinition, NoopPlanDefinition, PersistDefinition, ReplicateDefinition, StressBenchDefinition

public interface PlanDefinition<T extends JobConfig,P extends java.io.Serializable,R extends java.io.Serializable>

A job definition. A definition has two important parts: (1) a selectExecutors(JobConfig, List, SelectExecutorsContext) method runs at the master node and selects the workers to run the executors. (2) a runTask(JobConfig, Serializable, RunTaskContext) method runs at each selected executor on the worker node.

Method Summary

Modifier and Type	Method and Description
java.lang.Class<T>	getJobConfigClass()
java.lang.String	join(T config, java.util.Map<WorkerInfo,R> taskResults) Joins the task results on the master.
R	runTask(T config, P args, RunTaskContext runTaskContext) Runs the task in the executor.
java.util.Set<Pair<WorkerInfo,P>>	selectExecutors(T config, java.util.List<WorkerInfo> jobWorkerInfoList, SelectExecutorsContext selectExecutorsContext) Selects the workers to run the task.

Method Detail

getJobConfigClass

java.lang.Class<T> getJobConfigClass()

Returns:

the class of the associated JobConfig

selectExecutors

java.util.Set<Pair<WorkerInfo,P>> selectExecutors(T config,
                                                  java.util.List<WorkerInfo> jobWorkerInfoList,
                                                  SelectExecutorsContext selectExecutorsContext)
                                           throws java.lang.Exception

Selects the workers to run the task.

Parameters:

config - the job configuration

jobWorkerInfoList - the list of available workers' information

selectExecutorsContext - the context containing information used to select executors

Returns:

a set of pairs of selected workers to the parameters to pass along

Throws:

java.lang.Exception - if any error occurs

runTask

R runTask(T config,
          P args,
          RunTaskContext runTaskContext)
   throws java.lang.Exception

Runs the task in the executor.

Parameters:

config - the job configuration

args - the arguments passed in

runTaskContext - the context containing information used to execute a task

Returns:

the task result

Throws:

java.lang.Exception - if any error occurs

join

java.lang.String join(T config,
                      java.util.Map<WorkerInfo,R> taskResults)
               throws java.lang.Exception

Joins the task results on the master.

Parameters:

config - the job configuration

taskResults - the task results

Returns:

the joined results

Throws:

java.lang.Exception - if any error occurs