water.api

Class JobV2<J extends Job,S extends JobV2<J,S>>

java.lang.Object

water.Iced

water.api.Schema<J,S>

water.api.JobV2<J,S>

All Implemented Interfaces:

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

public class JobV2<J extends Job,S extends JobV2<J,S>>
extends Schema<J,S>

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
KeySchema	dest
java.lang.String	exception
KeyV1.JobKeyV1	key
long	msec
float	progress
java.lang.String	status

Fields inherited from class water.api.Schema

__meta, _impl_class, _version_pattern

Constructor Summary

Constructors

Constructor and Description
JobV2()
JobV2(Key<Job> key, java.lang.String description, java.lang.String status, float progress, long msec, Key dest, java.lang.String exception)

Method Summary

Methods

Modifier and Type	Method and Description
J	createImpl() Create an implementation object and any child objects but DO NOT fill them.
S	fillFromImpl(Job job) Version and Schema-specific filling from the implementation object.
static java.lang.String	link(Key key)
DocGen.HTML	writeHTML_impl(DocGen.HTML ab) Implementation of the Iced serialization protocol, only called by auto-genned code.

Methods inherited from class water.api.Schema

acceptsFrame, createAndFillImpl, extractVersion, fillFromParms, fillImpl, getHighestSupportedVersion, getImplClass, getImplClass, getLatestVersion, getSchemaVersion, markdown, markdown, markdown, markdown, newInstance, register, registerAllSchemasIfNecessary, schema, schema, schema, schema, schema, schemaClass, schemaClass, schemaClass, schemaClass, schemas

Methods inherited from class water.Iced

clone, frozenType, read_impl, read, readExternal, readJSON_impl, readJSON, toJsonString, write_impl, write, writeExternal, writeHTML, writeJSON_impl, 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 KeyV1.JobKeyV1 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

msec

@API(help="runtime",
     direction=OUTPUT)
public long msec

dest

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

exception

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

Constructor Detail

JobV2

public JobV2()

JobV2

public JobV2(Key<Job> key,
     java.lang.String description,
     java.lang.String status,
     float progress,
     long msec,
     Key dest,
     java.lang.String exception)

Method Detail

createImpl

public J createImpl()

Description copied from class: Schema

Create an implementation object and any child objects but DO NOT fill them. The 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<J extends Job,S extends JobV2<J,S>>

fillFromImpl

public S fillFromImpl(Job job)

Description copied from class: Schema

Version and Schema-specific filling from the implementation object.

Overrides:

fillFromImpl in class Schema<J extends Job,S extends JobV2<J,S>>

link

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

writeHTML_impl

public DocGen.HTML writeHTML_impl(DocGen.HTML ab)

Description copied from class: Iced

Implementation of the Iced serialization protocol, only called by auto-genned code. Not intended to be called by user code. Override only for custom Iced serializers.

Specified by:

writeHTML_impl in interface Freezable

Overrides:

writeHTML_impl in class Iced

Parameters:

ab - html to write object to.

Returns:

Returns the instance of HTML object.