water

Class Job<T extends Keyed>

java.lang.Object

water.Iced

water.Keyed

water.Job<T>

All Implemented Interfaces:

java.lang.Cloneable, Freezable

Direct Known Subclasses:

ModelBuilder, ParseDataset2

public class Job<T extends Keyed>
extends Keyed

Jobs are Keyed, because they need to Key to control e.g. atomic updates. Jobs produce a Keyed result, such as a Frame (from Parsing), or a Model.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Job.JobState Possible job states.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	_description Basic metadata about the Job
Key	_dest Jobs produce a single DKV result into Key _dest
long	_end_time
java.lang.String	_exception
long	_start_time
Job.JobState	_state
long	_work Returns a float from 0 to 1 representing progress.
static Key	LIST A system key for global list of Job keys.

Fields inherited from class water.Keyed

_key

Constructor Summary

Constructors

Constructor and Description
Job(Key dest, java.lang.String desc, long work) Create a Job

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Signal cancellation of this job.
void	cancel(java.lang.String msg) Signal exceptional cancellation of this job.
void	cancel2(java.lang.Throwable ex) Signal exceptional cancellation of this job.
Key	dest()
void	done() Marks job as finished and records job end time.
T	get() Blocks and get result of this job.
boolean	isRunning() Returns true if this job is running
static boolean	isRunning(Key job_key) Check if given job is running.
boolean	isStopped() Returns true if this job was started and is now stopped
static Job[]	jobs()
long	msec() Current runtime; zero if not started
protected void	onCancelled() Callback which is called after job cancellation (by user, by exception).
float	progress()
Job	start(H2O.H2OCountedCompleter fjtask) Start this task based on given top-level fork-join task representing job computation.
void	update(long newworked)
static void	update(long newworked, Key jobkey)

Methods inherited from class water.Keyed

remove_impl, remove, remove, remove, remove

Methods inherited from class water.Iced

clone, frozenType, read_impl, read, readJSON_impl, readJSON, write_impl, write, writeHTML_impl, writeHTML, writeJSON_impl, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

LIST

public static final Key LIST

A system key for global list of Job keys.

_dest

public final Key _dest

Jobs produce a single DKV result into Key _dest

_description

public final java.lang.String _description

Basic metadata about the Job

_start_time

public long _start_time

_end_time

public long _end_time

_exception

public java.lang.String _exception

_state

public Job.JobState _state

_work

public final long _work

Returns a float from 0 to 1 representing progress. Polled periodically. Can default to returning e.g. 0 always.

Constructor Detail

Job

public Job(Key dest,
   java.lang.String desc,
   long work)

Create a Job

Parameters:

dest - Final result Key to be produced by this Job

desc - String description

work - Units of work to be completed

Method Detail

jobs

public static Job[] jobs()

dest

public final Key dest()

isRunning

public boolean isRunning()

Returns true if this job is running

Returns:

returns true only if this job is in running state.

isStopped

public boolean isStopped()

Returns true if this job was started and is now stopped

isRunning

public static boolean isRunning(Key job_key)

Check if given job is running.

Parameters:

job_key - job key

Returns:

true if job is still running else returns false.

msec

public final long msec()

Current runtime; zero if not started

start

public Job start(H2O.H2OCountedCompleter fjtask)

Start this task based on given top-level fork-join task representing job computation.

Parameters:

fjtask - top-level job computation task.

Returns:

this job in Job.JobState.RUNNING state

See Also:

Job.JobState, H2O.H2OCountedCompleter

get

public T get()

Blocks and get result of this job.

The call blocks on working task which was passed via #start(H2OCountedCompleter) method and returns the result which is fetched from UKV based on job destination key.

Returns:

result of this job fetched from UKV by destination key.

See Also:

#start(H2OCountedCompleter), DKV

done

public void done()

Marks job as finished and records job end time.

cancel

public void cancel()

Signal cancellation of this job.

The job will be switched to state Job.JobState.CANCELLED which signals that the job was cancelled by a user.

cancel2

public void cancel2(java.lang.Throwable ex)

Signal exceptional cancellation of this job.

Parameters:

ex - exception causing the termination of job.

cancel

public void cancel(java.lang.String msg)

Signal exceptional cancellation of this job.

Parameters:

msg - cancellation message explaining reason for cancelation

onCancelled

protected void onCancelled()

Callback which is called after job cancellation (by user, by exception).

progress

public final float progress()

update

public final void update(long newworked)

update

public static void update(long newworked,
          Key jobkey)