Job (h2o-core 3.42.0 API)

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

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Freezable<Job>
```
public final class Job<T extends Keyed>
extends Keyed<Job>
```
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 are generic on Keyed, because their primary result is a Keyed result - which is Not a Job. Obvious examples are Frames (from running Parse or CreateFrame jobs), or Models (from running ModelBuilder jobs).
Long running tasks will has-a Job, not is-a Job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Job.JobCancelledException

static class Job.JobStatus

Nested Classes
Modifier and Type	Class and Description
`static class`	`Job.JobCancelledException`
`static class`	`Job.JobStatus`

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String`	`_description` User description
`long`	`_max_runtime_msecs`
`Key<T>`	`_result` Result Key
`int`	`_typeid`
`long`	`_work` Total expected work.
`static Key<Job>`	`LIST` A system key for global list of Job keys.
`static long`	`WORK_UNKNOWN`

Fields inherited from class water.Keyed
_key

Constructor Summary

Constructors
Constructor and Description
`Job(Key<Job> jobKey, Key<T> resultKey, java.lang.String clz_of_T, java.lang.String desc, boolean recoverable)` Create a Job
`Job(Key<T> key, java.lang.String clz_of_T, java.lang.String desc)` Create a Job
`Job(Key<T> key, java.lang.String clz_of_T, java.lang.String desc, java.lang.String warningStr)` Create a Job when a warning already exists due to bad model_id

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`blockingWaitForDone(long timeoutMillis)` Waits if necessary for at most the given time for the Job to complete.
`long`	`end_time()`
`java.lang.Throwable`	`ex()`
`void`	`fail(java.lang.Throwable ex)`
`T`	`get()` Blocks until the Job completes
`Job.JobStatus`	`getStatus()`
`long`	`getWork()`
`static boolean`	`isCancelledException(java.lang.Throwable ex)`
`boolean`	`isCrashed()`
`boolean`	`isCrashing()`
`boolean`	`isDone()`
`boolean`	`isRecoverable()`
`boolean`	`isRunning()`
`boolean`	`isStopped()`
`boolean`	`isStopping()`
`static Job[]`	`jobs()` The list of all Jobs, past and present.
`java.lang.Class<KeyV3.JobKeyV3>`	`makeSchema()`
`long`	`msec()` Current runtime; zero if not started.
`java.lang.String`	`progress_msg()` Returns last progress message.
`float`	`progress()` Returns a float from 0 to 1 representing progress.
`boolean`	`readyForView()`
`void`	`setReadyForView(boolean ready)`
`void`	`setWarnings(java.lang.String[] warns)`
`void`	`setWork(long work)` Set the amount of work for this job - can only be called if job was started without work specification
`long`	`start_time()`
`Job<T>`	`start(H2O.H2OCountedCompleter fjtask, long work)` Start this task based on given top-level fork-join task representing job computation.
`Job<T>`	`start(H2O.H2OCountedCompleter fjtask, long work, double max_runtime_secs)`
`boolean`	`stop_requested()`
`void`	`stop()`
`static Job<?>`	`tryGetDoneJob(Key<Job> key, long timeMillis)` Tries to retrieve a completed Job from DKV.
`void`	`update(long newworked)`
`static void`	`update(long newworked, Key<Job> jobkey)`
`void`	`update(long newworked, java.lang.String msg)` Report new work done for this job
`static void`	`update(long newworked, java.lang.String msg, Key<Job> jobkey)`
`void`	`warn(java.lang.String warn)`
`java.lang.String[]`	`warns()`

Methods inherited from class water.Keyed
checksum_impl, checksum_impl, checksum, checksum, getKey, readAll_impl, readAll, remove_impl, remove_impl, remove_self_key_impl, remove, remove, remove, remove, remove, remove, removeQuietly, writeAll_impl, writeAll

Methods inherited from class water.Iced
asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonBytes, toJsonString, write, writeExternal, writeJSON

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _result
```
public final Key<T extends Keyed> _result
```
    Result Key
  - _typeid
```
public final int _typeid
```
  - _description
```
public final java.lang.String _description
```
    User description
  - _work
```
public long _work
```
    Total expected work.
  - _max_runtime_msecs
```
public long _max_runtime_msecs
```
  - LIST
```
public static final Key<Job> LIST
```
    A system key for global list of Job keys.
  - WORK_UNKNOWN
```
public static final long WORK_UNKNOWN
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Job
```
public Job(Key<Job> jobKey,
           Key<T> resultKey,
           java.lang.String clz_of_T,
           java.lang.String desc,
           boolean recoverable)
```
    Create a Job
    
    Parameters:
    
    jobKey - Key for this job
    
    resultKey - Key of the final result
    
    clz_of_T - String class of the Keyed result
    
    desc - String description
    
    recoverable - Boolean indicating that this job is recoverable
  - Job
```
public Job(Key<T> key,
           java.lang.String clz_of_T,
           java.lang.String desc)
```
    Create a Job
    
    Parameters:
    
    key - Key of the final result
    
    clz_of_T - String class of the Keyed result
    
    desc - String description
  - Job
```
public Job(Key<T> key,
           java.lang.String clz_of_T,
           java.lang.String desc,
           java.lang.String warningStr)
```
    Create a Job when a warning already exists due to bad model_id
    
    Parameters:
    
    key - Key of the final result
    
    clz_of_T - String class of the Keyed result
    
    desc - String description
    
    warningStr - String contains a warning on model_id
- Method Detail
  - warn
```
public void warn(java.lang.String warn)
```
  - setWarnings
```
public void setWarnings(java.lang.String[] warns)
```
  - start_time
```
public long start_time()
```
  - end_time
```
public long end_time()
```
  - isRunning
```
public boolean isRunning()
```
  - isStopped
```
public boolean isStopped()
```
  - isStopping
```
public boolean isStopping()
```
  - isDone
```
public boolean isDone()
```
  - isCrashing
```
public boolean isCrashing()
```
  - isCrashed
```
public boolean isCrashed()
```
  - getStatus
```
public Job.JobStatus getStatus()
```
  - msec
```
public long msec()
```
    Current runtime; zero if not started.
  - isRecoverable
```
public boolean isRecoverable()
```
  - readyForView
```
public boolean readyForView()
```
  - setReadyForView
```
public void setReadyForView(boolean ready)
```
  - stop_requested
```
public boolean stop_requested()
```
  - stop
```
public void stop()
```
  - fail
```
public void fail(java.lang.Throwable ex)
```
  - ex
```
public java.lang.Throwable ex()
```
  - 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,
                         java.lang.String msg)
```
    Report new work done for this job
  - update
```
public final void update(long newworked)
```
  - update
```
public static void update(long newworked,
                          Key<Job> jobkey)
```
  - update
```
public static void update(long newworked,
                          java.lang.String msg,
                          Key<Job> jobkey)
```
  - warns
```
public java.lang.String[] warns()
```
  - jobs
```
public static Job[] jobs()
```
    The list of all Jobs, past and present.
    
    Returns:
    
    The list of all Jobs, past and present
  - getWork
```
public final long getWork()
```
  - setWork
```
public final void setWork(long work)
```
    Set the amount of work for this job - can only be called if job was started without work specification
  - start
```
public Job<T> start(H2O.H2OCountedCompleter fjtask,
                    long work,
                    double max_runtime_secs)
```
  - 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 - Amount of work to-do, for updating progress bar
    
    Returns:
    
    this job in isRunning() state
    
    See Also:
    
    H2O.H2OCountedCompleter
  - isCancelledException
```
public static boolean isCancelledException(java.lang.Throwable ex)
```
  - get
```
public T get()
```
    Blocks until the Job completes
  - makeSchema
```
public java.lang.Class<KeyV3.JobKeyV3> makeSchema()
```
    Overrides:
    
    makeSchema in class Keyed<Job>
  - tryGetDoneJob
```
public static Job<?> tryGetDoneJob(Key<Job> key,
                                   long timeMillis)
```
    Tries to retrieve a completed Job from DKV. It will wait up to given timeout period if the requested job is still running - giving it a chance to complete before this method has to return.
    
    Parameters:
    
    key - job key
    
    timeMillis - timeout period in milliseconds, if job is still running it will wait up to this amount of time for the job to finish
    
    Returns:
    
    null, if job doesn't exist, a Job instance otherwise
  - blockingWaitForDone
```
public void blockingWaitForDone(long timeoutMillis)
```
    Waits if necessary for at most the given time for the Job to complete. The wait is always blocking regardless if called from an F/J thread or a regular thread.
    
    Parameters:
    
    timeoutMillis - the maximum time in milliseconds to wait

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

_result

_typeid

_description

_work

_max_runtime_msecs

LIST

WORK_UNKNOWN

Constructor Detail

Job

Job

Job

Method Detail

warn

setWarnings

start_time

end_time

isRunning

isStopped

isStopping

isDone

isCrashing

isCrashed

getStatus

msec

isRecoverable

readyForView

setReadyForView

stop_requested

stop

fail

ex

progress

progress_msg

update

update

update

update

warns

jobs

getWork

setWork

start

start

isCancelledException

get

makeSchema

tryGetDoneJob

blockingWaitForDone