water

Class Job

java.lang.Object

water.Iced

water.api.Constants

water.api.RequestStatics

water.api.RequestArguments

water.api.RequestQueries

water.api.RequestBuilders

water.api.Request

water.Request2

water.Job

All Implemented Interfaces:

java.lang.Cloneable, Freezable

Direct Known Subclasses:

DRF.DRFJob, GLM2.GLMGridSearch, GLMGrid, GridSearch, Job.ChunkProgressJob, Job.FrameJob, Job.HexJob, KMeans, ParseDataset, ParseDataset2

public abstract class Job
extends Request2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Job.ChunkProgress
static class	Job.ChunkProgressJob
static class	Job.ColumnsJob A job which has an input represented by a frame and frame column filter.
static class	Job.Fail
static class	Job.FrameJob A job which operates with a frame.
static class	Job.HexJob
static class	Job.JobCancelledException
static class	Job.JobState Possible job states.
static class	Job.ModelJob A job producing a model.
static interface	Job.Progress
static interface	Job.ProgressMonitor
static class	Job.ValidatedJob Job which produces model and validate it on a given dataset.

Nested classes/interfaces inherited from class water.Request2

Request2.ColumnSelect, Request2.Dependent, Request2.DoClassBoolean, Request2.DRFCopyDataBoolean, Request2.MultiVecSelect, Request2.MultiVecSelectType, Request2.TypeaheadKey, Request2.VecClassSelect, Request2.VecSelect

Nested classes/interfaces inherited from class water.api.Request

Request.API, Request.Default, Request.Filter, Request.Validator<V>

Nested classes/interfaces inherited from class water.api.RequestBuilders

RequestBuilders.ArrayBuilder, RequestBuilders.ArrayHeaderRowBuilder, RequestBuilders.ArrayRowBuilder, RequestBuilders.ArrayRowElementBuilder, RequestBuilders.ArrayRowSingleColBuilder, RequestBuilders.BooleanStringBuilder, RequestBuilders.Builder, RequestBuilders.ElementBuilder, RequestBuilders.HideBuilder, RequestBuilders.KeyCellBuilder, RequestBuilders.KeyElementBuilder, RequestBuilders.KeyLinkElementBuilder, RequestBuilders.KeyMinAvgMaxBuilder, RequestBuilders.NoCaptionObjectBuilder, RequestBuilders.ObjectBuilder, RequestBuilders.PaginatedTable, RequestBuilders.PreFormattedBuilder, RequestBuilders.Response, RequestBuilders.ResponseInfo, RequestBuilders.WarningCellBuilder

Nested classes/interfaces inherited from class water.api.RequestArguments

RequestArguments.Argument<T>, RequestArguments.Bool, RequestArguments.CaseModeSelect, RequestArguments.CaseSelect, RequestArguments.ClassifyBool, RequestArguments.DRFCopyDataBool, RequestArguments.EnumArgument<T extends java.lang.Enum<T>>, RequestArguments.ExistingFile, RequestArguments.FrameClassVec, RequestArguments.FrameKeyMultiVec, RequestArguments.FrameKeyVec, RequestArguments.GeneralFile, RequestArguments.H2OCategoryStrata, RequestArguments.H2OCategoryWeights, RequestArguments.H2OExistingKey, RequestArguments.H2OGLMModelKey, RequestArguments.H2OHexKey, RequestArguments.H2OHexKeyCol, RequestArguments.H2OIllegalArgumentException, RequestArguments.H2OKey, RequestArguments.H2OKey2, RequestArguments.H2OKMeansModelKey, RequestArguments.H2OModelKey<TM extends OldModel,TK extends TypeaheadKeysRequest>, RequestArguments.HexAllColumnSelect, RequestArguments.HexColumnSelect, RequestArguments.HexKeyClassCol, RequestArguments.HexNonClassColumnSelect, RequestArguments.HexNonConstantColumnSelect, RequestArguments.HexPCAColumnSelect, RequestArguments.InputCheckBox, RequestArguments.InputSelect<T>, RequestArguments.InputText<T>, RequestArguments.Int, RequestArguments.LongInt, RequestArguments.MultipleSelect<T>, RequestArguments.MultipleText<T>, RequestArguments.NTree, RequestArguments.NumberSequence, RequestArguments.NumberSequenceFloat, RequestArguments.Real, RequestArguments.Record<T>, RequestArguments.RFModelKey, RequestArguments.RSeq, RequestArguments.RSeqFloat, RequestArguments.Str, RequestArguments.StringList, RequestArguments.TypeaheadInputText<T>

Nested classes/interfaces inherited from class water.api.RequestStatics

RequestStatics.RequestType

Nested classes/interfaces inherited from class water.api.Constants

Constants.Extensions, Constants.Schemes, Constants.Suffixes

Field Summary

Fields

Modifier and Type	Field and Description
H2O.H2OCountedCompleter	_fjtask
static long	CANCELLED_END_TIME
java.lang.String	description
Key	destination_key
static DocGen.FieldDoc[]	DOC_FIELDS
long	end_time
java.lang.String	exception
Key	job_key
long	start_time
Job.JobState	state

Fields inherited from class water.Request2

_parms, response_info

Fields inherited from class water.api.Request

_requestHelp, SUPPORTS_ONLY_V1, SUPPORTS_ONLY_V2, SUPPORTS_V1_V2

Fields inherited from class water.api.RequestBuilders

ARRAY_BUILDER, ARRAY_HEADER_ROW_BUILDER, ARRAY_ROW_BUILDER, ARRAY_ROW_ELEMENT_BUILDER, ARRAY_ROW_SINGLECOL_BUILDER, ELEMENT_BUILDER, GSON_BUILDER, OBJECT_BUILDER, ROOT_OBJECT

Fields inherited from class water.api.RequestQueries

_queryHtml

Fields inherited from class water.api.RequestArguments

_arguments

Fields inherited from class water.api.Constants

ALPHA, ARGUMENTS, AUC, BASE, BEST_THRESHOLD, BETA_EPS, BIN_LIMIT, BROWSE, BUCKET, BUILT_IN_KEY_JOBS, CANCELLED, CARDINALITY, CASE, CASE_MODE, CHUNK, CLASS, CLOUD_HEALTH, CLOUD_NAME, CLOUD_SIZE, CLOUD_UPTIME_MILLIS, CLUSTERS, COEFFICIENTS, COL_INDEX, COLS, COLUMN_NAME, COLUMNS_DISPLAY, CONSENSUS, CONTENTS, COUNT, DATA_KEY, DEPTH, DESCRIPTION, DEST_KEY, DTHRESHOLDS, ELAPSED, END_TIME, ENUM_DOMAIN_SIZE, ERROR, ESCAPE_NAN, EXCLUSIVE_SPLIT_LIMIT, EXPRESSION, FAILED, FAMILY, FEATURES, FILE, FILES, FILTER, FIRST_CHUNK, FJ_QUEUE_HI, FJ_QUEUE_LO, FJ_THREADS_HI, FJ_THREADS_LO, FREE_DISK, FREE_MEM, HEADER, HEIGHT, HELP, IGNORE, ITEMS, ITERATIVE_CM, JOB, JOB_KEY, JOBS, JSON_H2O, KEY, KEYS, LAMBDA, LAST_CONTACT, LIMIT, LINK, LOCKED, MAX, MAX_DISK, MAX_ITER, MAX_MEM, MAX_ROWS, MEAN, MIN, MODEL_KEY, MODELS, MORE, MTRY, MTRY_NODES, NAME, NEG_X, NO_CM, NODE, NODE_HEALTH, NODE_NAME, NODES, NORMALIZE, NUM_COLS, NUM_CPUS, NUM_FAILED, NUM_KEYS, NUM_MISSING_VALUES, NUM_ROWS, NUM_SUCCEEDED, NUM_TREES, OBJECT, OFFSET, OOBEE, PARALLEL, PARSER_TYPE, PATH, PREVIEW, PREVIOUS_MODEL_KEY, PROGRESS, PROGRESS_KEY, PROGRESS_TOTAL, REDIRECT, REDIRECT_ARGS, REPLICATION_FACTOR, REQUEST_TIME, RESPONSE, RHO, ROW, ROW_SIZE, ROWS, RPCS, SAMPLE, SAMPLING_STRATEGY, SCALE, SEED, SENT_ROWS, SEPARATOR, SIZE, SOURCE_KEY, STACK_TRACES, START_TIME, STAT_TYPE, STATUS, STEP, STRATA_SAMPLES, SUCCEEDED, SYSTEM_LOAD, TASK_KEY, TCPS_ACTIVE, TCPS_DUTY, TIME, TO_ENUM, TOT_MEM, TREE_COUNT, TREE_DEPTH, TREE_LEAVES, TREE_NUM, TREES, TWEEDIE_POWER, TYPE, URL, USE_NON_LOCAL_DATA, VALUE, VALUE_SIZE, VALUE_TYPE, VARIANCE, VERSION, VIEW, WARNINGS, WEIGHT, WEIGHTS, WIDTH, X, XVAL, Y

Constructor Summary

Constructors

Constructor and Description
Job()
Job(Key jobKey, Key dstKey)

Method Summary

Methods

Modifier and Type	Method and Description
static Job[]	all() Returns a list of all jobs in a system.
void	cancel()
void	cancel(java.lang.String msg)
void	cancel(java.lang.Throwable ex)
static boolean	checkIdx(Frame source, int[] idx)
protected void	cleanup() Clean-up code which is executed after each exec() call in any case (normal/exceptional).
protected Key	defaultDestKey()
protected Key	defaultJobKey()
Key	dest()
protected void	emptyLTrash() User call which empty local trash of vectors.
protected Job.JobState	execImpl()
static Job	findJob(Key jobkey) Finds a job with given key or returns null.
static Job	findJobByDest(Key destKey) Finds a job with given dest key or returns null
Job	fork() Forks computation of this job.
<T> T	get()
int	gridParallelism()
protected void	gtrash(Frame fr) Append all vectors from given frame to a global clean up list.
protected void	gtrash(Vec... vec) Append given vector to clean up list.
protected void	init() Invoked before job runs.
void	invoke()
boolean	isCancelled()
boolean	isCrashed()
boolean	isDone()
static boolean	isEnded(Key jobkey) Returns true if job is not running.
static boolean	isRunning(Key job_key) Check if given job is running.
protected void	ltrash(Frame fr) Put given frame vectors into local trash which can be emptied by a user calling the emptyLTrash() method.
protected void	ltrash(Vec... vec) Put given vectors into local trash.
protected void	onCancelled() Callback which is called after job cancellation (by user, by exception).
float	progress()
protected RequestBuilders.Response	redirect()
void	remove() Marks job as finished and records job end time.
long	runTimeMs() Returns job execution time in milliseconds.
Key	self()
protected RequestBuilders.Response	serve()
java.lang.String	speedDescription() Description of a speed criteria: msecs/frob
long	speedValue() Value of the described speed criteria: msecs/frob
Job	start(H2O.H2OCountedCompleter fjtask)
static void	waitUntilJobEnded(Key jobkey) Block synchronously waiting for a job to end, success or not.
static void	waitUntilJobEnded(Key jobkey, int pollingIntervalMillis) Block synchronously waiting for a job to end, success or not.

Methods inherited from class water.Request2

create, fillResponseInfo, input, logStart, makeJsonBox, registered, serveGrid, set, split, superServeGrid, supportedVersions, toJSON, toString

Methods inherited from class water.api.Request

addToNavbar, addToNavbar, addToNavbar, DocExampleFail, DocExampleSucc, href, href, hrefType, HTMLHelp, htmlTemplate, initializeNavBar, log, mapTypeahead, ReSTHelp, serve, serveJava, toDocGET, toHTML, toJava, wrap, wrap, wrap, writeJSONFields

Methods inherited from class water.api.RequestBuilders

build, buildJSONResponseBox, buildResponseHeader, name

Methods inherited from class water.api.RequestQueries

buildQuery, checkArguments, queryArgumentValueSet

Methods inherited from class water.api.RequestArguments

arguments, argumentsToJson, frameColumnNameToIndex, vaCategoryNames, vaCategoryNames, vaColumnNameToIndex

Methods inherited from class water.api.RequestStatics

checkJsonName, encodeRedirectArgs, JSON2HTML, jsonError, requestName, Str2JSON

Methods inherited from class water.Iced

clone, frozenType, init, newInstance, read, toDocField, write, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

DOC_FIELDS

public static DocGen.FieldDoc[] DOC_FIELDS

CANCELLED_END_TIME

public static final long CANCELLED_END_TIME

See Also:

Constant Field Values

job_key

public Key job_key

destination_key

public Key destination_key

description

public java.lang.String description

start_time

public long start_time

end_time

public long end_time

exception

public java.lang.String exception

state

public Job.JobState state

_fjtask

public transient H2O.H2OCountedCompleter _fjtask

Constructor Detail

Job

public Job(Key jobKey,
   Key dstKey)

Job

public Job()

Method Detail

self

public Key self()

dest

public Key dest()

gridParallelism

public int gridParallelism()

cleanup

protected void cleanup()

Clean-up code which is executed after each exec() call in any case (normal/exceptional).

emptyLTrash

protected final void emptyLTrash()

User call which empty local trash of vectors.

gtrash

protected final void gtrash(Frame fr)

Append all vectors from given frame to a global clean up list.

See Also:

cleanup(), _gVecTrash

gtrash

protected final void gtrash(Vec... vec)

Append given vector to clean up list.

See Also:

cleanup()

ltrash

protected final void ltrash(Frame fr)

Put given frame vectors into local trash which can be emptied by a user calling the emptyLTrash() method.

See Also:

emptyLTrash()

ltrash

protected final void ltrash(Vec... vec)

Put given vectors into local trash. * @see #emptyLTrash()

defaultJobKey

protected Key defaultJobKey()

defaultDestKey

protected Key defaultDestKey()

start

public Job start(H2O.H2OCountedCompleter fjtask)

progress

public float progress()

get

public <T> T get()

cancel

public void cancel()

cancel

public void cancel(java.lang.Throwable ex)

cancel

public void cancel(java.lang.String msg)

onCancelled

protected void onCancelled()

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

isCancelled

public boolean isCancelled()

isCrashed

public boolean isCrashed()

isDone

public boolean isDone()

all

public static Job[] all()

Returns a list of all jobs in a system.

Returns:

list of all jobs including running, done, cancelled, crashed jobs.

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.

isEnded

public static boolean isEnded(Key jobkey)

Returns true if job is not running. The job can be cancelled, crashed, or already done.

Parameters:

jobkey - job identification key

Returns:

true if job is done, cancelled, or crashed, else false

remove

public void remove()

Marks job as finished and records job end time.

findJob

public static final Job findJob(Key jobkey)

Finds a job with given key or returns null.

Parameters:

jobkey - job key

Returns:

returns a job with given job key or null if a job is not found.

findJobByDest

public static final Job findJobByDest(Key destKey)

Finds a job with given dest key or returns null

runTimeMs

public final long runTimeMs()

Returns job execution time in milliseconds. If job is not running then returns job execution time.

speedDescription

public java.lang.String speedDescription()

Description of a speed criteria: msecs/frob

speedValue

public long speedValue()

Value of the described speed criteria: msecs/frob

serve

protected RequestBuilders.Response serve()

Specified by:

serve in class Request

redirect

protected RequestBuilders.Response redirect()

fork

public Job fork()

Forks computation of this job.

The call does not block.

Returns:

always returns this job.

invoke

public void invoke()

init

protected void init()
             throws java.lang.IllegalArgumentException

Invoked before job runs. This is the place to checks arguments are valid or throw IllegalArgumentException. It will get invoked both from the Web and Java APIs.

Throws:

java.lang.IllegalArgumentException - throws the exception if initialization fails to ensure correct job runtime environment.

execImpl

protected Job.JobState execImpl()

waitUntilJobEnded

public static void waitUntilJobEnded(Key jobkey,
                     int pollingIntervalMillis)

Block synchronously waiting for a job to end, success or not.

Parameters:

jobkey - Job to wait for.

pollingIntervalMillis - Polling interval sleep time.

waitUntilJobEnded

public static void waitUntilJobEnded(Key jobkey)

Block synchronously waiting for a job to end, success or not.

Parameters:

jobkey - Job to wait for.

checkIdx

public static boolean checkIdx(Frame source,
               int[] idx)