Job (h2o-core 3.0.0 API)

java.lang.Object
- water.Iced<T>
- - water.Keyed
  - - water.Job<T>

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Freezable

Direct Known Subclasses:

CreateFrame, FrameUtils.MissingInserter, Grid.GridSearch, Interaction, ModelBuilder, ParseDataset, Transformer
```
public class Job<T extends Keyed>
extends Keyed
```
Jobs are used to do minimal tracking of long-lifetime user actions, including progress-bar updates and the ability to review in progress or completed Jobs, and cancel currently running Jobs.
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. NOTE: the Job class is parametrized on the type of its _dest field.

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Job.JobCancelledException` Simple named exception class
`static class`	`Job.JobState` Possible job states.
`static class`	`Job.Progress` Helper class to store the job progress in the DKV
`static class`	`Job.ProgressUpdate` Helper class to atomically update the job progress in the DKV

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String`	`_description` User description
`Key<T>`	`_dest` Jobs produce a single DKV result into Key _dest
`long`	`_end_time` Job end_time using Sys.CTM, or 0 if not ended
`java.lang.String`	`_exception` Any exception thrown by this Job, or null if none
`protected Key`	`_progressKey`
`long`	`_start_time` Job start_time using Sys.CTM
`Job.JobState`	`_state`
`static Key<Job>`	`LIST` A system key for global list of Job keys.

Fields inherited from class water.Keyed
_key

Constructor Summary

Constructors
Modifier Constructor and Description

protected Job(Key<T> jobKey, Key<T> dest, java.lang.String desc)

Job(Key<T> dest, java.lang.String desc)
Create a Job

Constructors
Modifier	Constructor and Description
`protected`	`Job(Key<T> jobKey, Key<T> dest, java.lang.String desc)`
	`Job(Key<T> dest, java.lang.String desc)` 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.
`protected long`	`checksum_impl()` Default checksum; not really used by Jobs.
`Key<T>`	`dest()` Since _dest is public final, not sure why we have a getter but some people like 'em.
`void`	`done()` Marks job as finished and records job end time.
`void`	`failed(java.lang.Throwable ex)` Signal exceptional cancellation of this job.
`T`	`get()` Blocks and get result of this job.
`boolean`	`isCancelledOrCrashed()` Returns true if the job was cancelled by the user or crashed.
`boolean`	`isDone()` Returns true if this job is done
`boolean`	`isRunning()` Returns true if this job is running
`static boolean`	`isRunning(Key<Job> job_key)` Check if given job is running.
`boolean`	`isStopped()` Returns true if this job was started and is now stopped
`static Job[]`	`jobs()` The list of all Jobs, past and present.
`long`	`msec()` Current runtime; zero if not started
`protected void`	`onCancelled()` Callback which is called after job cancellation (by user, by exception).
`java.lang.String`	`progress_msg()` Returns last progress message.
`float`	`progress()` Returns a float from 0 to 1 representing progress.
`protected Futures`	`remove_impl(Futures fs)` Override to remove subparts, but not self, of composite Keyed objects.
`Job<T>`	`start(H2O.H2OCountedCompleter fjtask, long work)` Start this task based on given top-level fork-join task representing job computation.
`void`	`update(long newworked)` Report new work done for this job
`static void`	`update(long newworked, Key<Job> jobkey)`
`void`	`update(long newworked, java.lang.String msg)`
`static void`	`update(long newworked, java.lang.String msg, Key<Job> jobkey)`

Methods inherited from class water.Keyed
checksum, remove, remove, remove, remove

Methods inherited from class water.Iced
clone, frozenType, read_impl, read, readExternal, readJSON_impl, readJSON, toJsonString, write_impl, write, writeExternal, 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<Job> LIST
```
    A system key for global list of Job keys.
  - _dest
```
public final Key<T extends Keyed> _dest
```
    Jobs produce a single DKV result into Key _dest
  - _description
```
public java.lang.String _description
```
    User description
  - _start_time
```
public long _start_time
```
    Job start_time using Sys.CTM
  - _end_time
```
public long _end_time
```
    Job end_time using Sys.CTM, or 0 if not ended
  - _exception
```
public java.lang.String _exception
```
    Any exception thrown by this Job, or null if none
  - _state
```
public Job.JobState _state
```
  - _progressKey
```
protected Key _progressKey
```
- Constructor Detail
  - Job
```
protected Job(Key<T> jobKey,
   Key<T> dest,
   java.lang.String desc)
```
  - Job
```
public Job(Key<T> dest,
   java.lang.String desc)
```
    Create a Job
    
    Parameters:
    dest - Final result Key to be produced by this Job
    desc - String description
- Method Detail
  - jobs
```
public static Job[] jobs()
```
    The list of all Jobs, past and present.
    
    Returns:
    The list of all Jobs, past and present
  - dest
```
public final Key<T> dest()
```
    Since _dest is public final, not sure why we have a getter but some people like 'em.
  - isCancelledOrCrashed
```
public boolean isCancelledOrCrashed()
```
    Returns true if the job was cancelled by the user or crashed.
    
    Returns:
    true if the job is in state Job.JobState.CANCELLED or Job.JobState.FAILED
  - isRunning
```
public boolean isRunning()
```
    Returns true if this job is running
    
    Returns:
    returns true only if this job is in running state.
  - isDone
```
public boolean isDone()
```
    Returns true if this job is done
    
    Returns:
    true if the job is in state Job.JobState.DONE
  - isStopped
```
public boolean isStopped()
```
    Returns true if this job was started and is now stopped
  - isRunning
```
public static boolean isRunning(Key<Job> 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<T> start(H2O.H2OCountedCompleter fjtask,
           long work)
```
    Start this task based on given top-level fork-join task representing job computation.
    
    Parameters:
    fjtask - top-level job computation task.
    work - Units of work to be completed
    
    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.
    This call blocks on working task which was passed via start(water.H2O.H2OCountedCompleter, long) method and returns the result which is fetched from DKV based on job destination key.
    
    Returns:
    result of this job fetched from DKV by destination key.
    See Also:
    start(water.H2O.H2OCountedCompleter, long), 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.
  - failed
```
public void failed(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 cancellation
  - onCancelled
```
protected void onCancelled()
```
    Callback which is called after job cancellation (by user, by exception).
  - progress
```
public float progress()
```
    Returns a float from 0 to 1 representing progress. Polled periodically. Can default to returning e.g. 0 always.
  - progress_msg
```
public java.lang.String progress_msg()
```
    Returns last progress message.
  - update
```
public final void update(long newworked)
```
    Report new work done for this job
  - update
```
public final void update(long newworked,
          java.lang.String msg)
```
  - update
```
public static void update(long newworked,
          Key<Job> jobkey)
```
  - update
```
public static void update(long newworked,
          java.lang.String msg,
          Key<Job> jobkey)
```
  - remove_impl
```
protected Futures remove_impl(Futures fs)
```
    Description copied from class: Keyed
    
    Override to remove subparts, but not self, of composite Keyed objects. Examples include Vec (removing associated Chunk keys) and Frame (removing associated Vec keys.)
    
    Overrides:
    
    remove_impl in class Keyed
  - checksum_impl
```
protected long checksum_impl()
```
    Default checksum; not really used by Jobs.
    
    Specified by:
    
    checksum_impl in class Keyed

Class Job<T extends Keyed>

Nested Class Summary

Field Summary

Fields inherited from class water.Keyed

Constructor Summary

Method Summary

Methods inherited from class water.Keyed

Methods inherited from class water.Iced

Methods inherited from class java.lang.Object

Field Detail

LIST

_dest

_description

_start_time

_end_time

_exception

_state

_progressKey

Constructor Detail

Job

Job

Method Detail

jobs

dest

isCancelledOrCrashed

isRunning

isDone

isStopped

isRunning

msec

start

get

done

cancel

failed

cancel

onCancelled

progress

progress_msg

update

update

update

update

remove_impl

checksum_impl