water.api.schemas3

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

java.lang.Object

water.Iced

water.api.Schema<I,S>

water.api.schemas3.SchemaV3<I,S>

All Implemented Interfaces:

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

Direct Known Subclasses:

AboutEntryV3, CapabilityEntryV3, CloudV3.NodeV3, ConfusionMatrixV3, FieldMetadataV3, FrameV3.ColSpecifierV3, FrameV3.ColV3, GarbageCollectV3, GridSchemaV99, GridSearchSchema, GridsV99, H2OErrorV3, HyperSpaceSearchCriteriaV99, JobV3, JStackV3.DStackTraceV3, KeyV3, KeyValueV3, ModelBuilderV3, ModelMetricsBaseV3, ModelOutputSchemaV3, ModelParameterSchemaV3, ModelParametersSchemaV3, ModelSchemaBaseV3, NodePersistentStorageV3.NodePersistentStorageEntryV3, PartialDependenceV3, ProfilerNodeV3, ProfilerNodeV3.ProfilerNodeEntryV3, RapidsHelpV3, RapidsHelpV3.RapidsExpressionV3, RequestSchemaV3, RouteV3, SchemaMetadataV3, SplitFrameV3, StreamingSchema, StringPairV3, TabulateV3, TimelineV3.EventV3, TwoDimTableV3, TwoDimTableV3.ColumnSpecsBase, ValidationMessageV3, VarImpV3, WaterMeterIo.IoStatsEntry

public class SchemaV3<I extends Iced,S extends SchemaV3<I,S>>
extends Schema<I,S>

Base Schema class for all v3 REST API objects. Any schema which is *NOT* used for requests (i.e. it cannot be an input to a REST API handler) should inherit from this class. However if a schema is used for requests, then it should inherit from RequestSchemaV3, which contains some additional fields common for all REST API requests.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SchemaV3.Meta Metadata for a Schema, including the version, name and type.

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

Schema.AutoParseable

Field Summary

Fields

Modifier and Type	Field and Description
SchemaV3.Meta	__meta

Constructor Summary

Constructors

Constructor and Description
SchemaV3()
SchemaV3(I impl)

Method Summary

Modifier and Type	Method and Description
AutoBuffer	writeJSON(AutoBuffer ab) Standard "write thyself into the AutoBuffer" call, using JSON.

Methods inherited from class water.api.Schema

createAndFillImpl, createImpl, extractVersionFromSchemaName, fillFromBody, fillFromImpl, fillFromImpl, fillFromImpl, fillFromParms, fillFromParms, fillImpl, fillImpl, getImplClass, getImplClass, getSchemaName, getSchemaType, getSchemaVersion, init_meta, markdown, markdown, newInstance, newInstance, setField, setSchemaType_doNotCall

Methods inherited from class water.Iced

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

Methods inherited from class java.lang.Object

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

Field Detail

__meta

@API(help="Metadata on this schema instance, to make it self-describing.",
     direction=OUTPUT)
public SchemaV3.Meta __meta

Constructor Detail

SchemaV3

public SchemaV3()

SchemaV3

public SchemaV3(I impl)

Method Detail

writeJSON

public AutoBuffer writeJSON(AutoBuffer ab)

Description copied from class: Iced

Standard "write thyself into the AutoBuffer" call, using JSON. Real work is in the delegate Icer classes.

Specified by:

writeJSON in interface Freezable

Overrides:

writeJSON in class Iced

Parameters:

ab - AutoBuffer to write this object to.

Returns:

Returns the original AutoBuffer for flow-coding.