water.api

Class JobV3

java.lang.Object

water.Iced

water.api.Schema<I,S>

water.api.RequestSchema<Job,JobV3>

water.api.JobV3

All Implemented Interfaces:

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

public class JobV3
extends RequestSchema<Job,JobV3>

Schema for a single Job.

See Also:

Serialized Form

Nested Class Summary

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

Schema.Meta

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	description
KeyV3	dest
java.lang.String	exception
KeyV3.JobKeyV3	key
long	msec
float	progress
java.lang.String	progress_msg
boolean	ready_for_view
java.lang.String	stacktrace
long	start_time
java.lang.String	status
java.lang.String[]	warnings

Fields inherited from class water.api.RequestSchema

_exclude_fields

Constructor Summary

Constructors

Constructor and Description
JobV3()

Method Summary

Methods

Modifier and Type	Method and Description
Job	createImpl() Create an appropriate implementation object and any child objects but does not fill them.
JobV3	fillFromImpl(Job job) Fill this Schema from the given implementation object.
static java.lang.String	link(Key key)

Methods inherited from class water.api.Schema

createAndFillImpl, fillFromParms, fillFromParms, fillImpl, get__meta, getExperimentalVersion, getHighestSupportedVersion, getImplClass, getImplClass, getLatestVersion, getSchemaVersion, init_meta, markdown, markdown, newInstance, newInstance, registerAllSchemasIfNecessary, schema, schema, schemaClass, schemaClass, schemas, setField

Methods inherited from class water.Iced

asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonString, write, writeExternal, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

key

@API(help="Job Key")
public KeyV3.JobKeyV3 key

description

@API(help="Job description")
public java.lang.String description

status

@API(help="job status",
     direction=OUTPUT)
public java.lang.String status

progress

@API(help="progress, from 0 to 1",
     direction=OUTPUT)
public float progress

progress_msg

@API(help="current progress status description",
     direction=OUTPUT)
public java.lang.String progress_msg

start_time

@API(help="Start time",
     direction=OUTPUT)
public long start_time

msec

@API(help="Runtime in milliseconds",
     direction=OUTPUT)
public long msec

dest

@API(help="destination key",
     direction=INOUT)
public KeyV3 dest

warnings

@API(help="exception",
     direction=OUTPUT)
public java.lang.String[] warnings

exception

@API(help="exception",
     direction=OUTPUT)
public java.lang.String exception

stacktrace

@API(help="stacktrace",
     direction=OUTPUT)
public java.lang.String stacktrace

ready_for_view

@API(help="ready for view",
     direction=OUTPUT)
public boolean ready_for_view

Constructor Detail

JobV3

public JobV3()

Method Detail

createImpl

public Job createImpl()

Description copied from class: Schema

Create an appropriate implementation object and any child objects but does not fill them. The standard purpose of a createImpl without a fillImpl is to be able to get the default values for all the impl's fields.

For objects without children this method does all the required work. For objects with children the subclass will need to override, e.g. by calling super.createImpl() and then calling createImpl() on its children.

Note that impl objects for schemas which override this method don't need to have a default constructor (e.g., a Keyed object constructor can still create and set the Key), but they must not fill any fields which can be filled later from the schema.

TODO: We could handle the common case of children with the same field names here by finding all of our fields that are themselves Schemas.

Overrides:

createImpl in class Schema<Job,JobV3>

fillFromImpl

public JobV3 fillFromImpl(Job job)

Description copied from class: Schema

Fill this Schema from the given implementation object. If a schema doesn't need to adapt any fields if does not need to override this method.

Overrides:

fillFromImpl in class Schema<Job,JobV3>

link

public static java.lang.String link(Key key)