water.api

Class Schema.Meta

java.lang.Object

water.Iced

water.api.Schema.Meta

All Implemented Interfaces:

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

Enclosing class:

Schema<I extends Iced,S extends Schema<I,S>>

public static final class Schema.Meta
extends Iced

Metadata for a Schema, including the version, name and type. This information is included in all REST API responses as a field in the Schema so that the payloads are self-describing, and it is also available through the /Metadata/schemas REST API endpoint for the purposes of REST service discovery.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Schema.Meta() Default constructor used only for newInstance() in generic reflection-based code.
Schema.Meta(int version, java.lang.String name, java.lang.String type) Standard constructor which supplies all the fields.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getSchema_name() Get the simple schema (class) name, for example DeepLearningParametersV3.
java.lang.String	getSchema_type() Get the simple name of the H2O type that this Schema represents, for example DeepLearningParameters.
int	getSchema_version() Get the version number of this schema, for example 3 or 99.
protected void	setSchema_type(java.lang.String schema_type) Set the simple name of the H2O type that this Schema represents, for example Key<Frame>.

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

Constructor Detail

Schema.Meta

public Schema.Meta()

Default constructor used only for newInstance() in generic reflection-based code.

Schema.Meta

public Schema.Meta(int version,
           java.lang.String name,
           java.lang.String type)

Standard constructor which supplies all the fields. The fields should be treated as immutable once set.

Method Detail

getSchema_version

public int getSchema_version()

Get the version number of this schema, for example 3 or 99. Note that 99 is the "experimental" version, meaning that there are no stability guarantees between H2O versions.

getSchema_name

public java.lang.String getSchema_name()

Get the simple schema (class) name, for example DeepLearningParametersV3.

getSchema_type

public java.lang.String getSchema_type()

Get the simple name of the H2O type that this Schema represents, for example DeepLearningParameters.

setSchema_type

protected void setSchema_type(java.lang.String schema_type)

Set the simple name of the H2O type that this Schema represents, for example Key<Frame>. NOTE: using this is a hack and should be avoided.