water.api.schemas3

Class SchemaV3.Meta

java.lang.Object

water.Iced

water.api.schemas3.SchemaV3.Meta

All Implemented Interfaces:

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

Enclosing class:

SchemaV3<I extends Iced,S extends SchemaV3<I,S>>

public static final class SchemaV3.Meta
extends Iced

Metadata for a Schema, including the version, name and type. This information is included in all v3 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

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	schema_name
java.lang.String	schema_type
int	schema_version

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString() Used during markdown generation.

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, wait, wait, wait

Field Detail

schema_version

@API(help="Version number of this Schema.  Must not be changed after creation (treat as final).",
     direction=OUTPUT)
public int schema_version

schema_name

@API(help="Simple name of this Schema.  NOTE: the schema_names form a single namespace.",
     direction=OUTPUT)
public java.lang.String schema_name

schema_type

@API(help="Simple name of H2O type that this Schema represents.  Must not be changed after creation (treat as final).",
     direction=OUTPUT)
public java.lang.String schema_type

Constructor Detail

Meta

public Meta()

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

Meta

public 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

toString

public java.lang.String toString()

Used during markdown generation.

Overrides:

toString in class java.lang.Object