alluxio.scheduler.job

Interface Job<T extends Task<?>>

Type Parameters:

T - the type of the task of the job

All Known Implementing Classes:

AbstractJob, LoadJob

public interface Job<T extends Task<?>>

interface for job that can be scheduled by Alluxio scheduler.

Method Summary

Modifier and Type	Method and Description
void	failJob(AlluxioRuntimeException reason) set job as failure with exception.
JobDescription	getDescription()
OptionalLong	getEndTime()
String	getJobId()
JobState	getJobState()
Optional<T>	getNextTask(WorkerInfo worker)
String	getProgress(JobProgressReportFormat format, boolean verbose) Get job progress.
void	initiateVerification() Initiate a verification pass.
boolean	isCurrentPassDone() Check whether the current pass is finished.
boolean	isDone() Check whether the job is finished.
boolean	isHealthy() Check whether the job is healthy.
boolean	isRunning() Check whether the job is still running.
boolean	needVerification()
boolean	processResponse(T task) process task result.
void	setJobState(JobState state) set job state.
Journal.JournalEntry	toJournalEntry()
void	updateJob(Job<?> job) update job configs.

Method Detail

getDescription

JobDescription getDescription()

Returns:

the job description, which is used to identify the intention of the job. We don't allow multiple jobs with the same description to be run on the scheduler at the same time. When submitting a job when there is already a job with the same description, scheduler will update the job instead of submitting a new job.

getEndTime

OptionalLong getEndTime()

Returns:

job end time if finished, otherwise empty

needVerification

boolean needVerification()

Returns:

whether the job need verification

getJobState

JobState getJobState()

Returns:

job state

setJobState

void setJobState(JobState state)

set job state.

Parameters:

state - job state

getJobId

String getJobId()

Returns:

job id. unique id for the job

failJob

void failJob(AlluxioRuntimeException reason)

set job as failure with exception.

Parameters:

reason - exception

getProgress

String getProgress(JobProgressReportFormat format,
                   boolean verbose)

Get job progress.

Parameters:

format - progress report format

verbose - whether to include detailed information

Returns:

job progress report

Throws:

IllegalArgumentException - if the format is not supported

isHealthy

boolean isHealthy()

Check whether the job is healthy.

Returns:

true if the job is healthy, false if not

isRunning

boolean isRunning()

Check whether the job is still running.

Returns:

true if the job is running, false if not

isDone

boolean isDone()

Check whether the job is finished.

Returns:

true if the job is finished, false if not

isCurrentPassDone

boolean isCurrentPassDone()

Check whether the current pass is finished.

Returns:

true if the current pass of job is finished, false if not

initiateVerification

void initiateVerification()

Initiate a verification pass. This will re-list the directory and find any unfinished files / tasks and try to execute them again.

getNextTask

Optional<T> getNextTask(WorkerInfo worker)

Parameters:

worker - blocker to worker

Returns:

the next task to run. If there is no more task to run, return empty

Throws:

AlluxioRuntimeException - if any error occurs when getting next task

toJournalEntry

Journal.JournalEntry toJournalEntry()

Returns:

job journal entry

processResponse

boolean processResponse(T task)

process task result.

Parameters:

task - task containing result future

Returns:

success if successfully process task result, otherwise return failure

updateJob

void updateJob(Job<?> job)

update job configs.

Parameters:

job - the job to update from. Must be the same job type