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, AboutV3, AssemblyV99, CloudV3, CloudV3.NodeV3, ConfusionMatrixV3, CreateFrameV3, DCTTransformerV3, DownloadDataV3, FieldMetadataV3, FindV3, FrameBaseV3, FramesV3, FrameV3.ColSpecifierV3, FrameV3.ColV3, GarbageCollectV3, GridSchemaV99, GridSearchSchema, GridsV99, H2OErrorV3, HyperSpaceSearchCriteriaV99, ImportFilesV3, ImportSQLTableV99, InitIDV3, InteractionV3, JobsV3, JobV3, JStackV3, JStackV3.DStackTraceV3, KeyV3, KillMinus3V3, LogAndEchoV3, LogsV3, MetadataV3, MissingInserterV3, ModelBuilderSchema, ModelBuildersV3, ModelBuilderV3, ModelExportV3, ModelImportV3, ModelMetricsBaseV3, ModelOutputSchemaV3, ModelParameterSchemaV3, ModelParametersSchemaV3, ModelSchemaBaseV3, ModelsV3, NetworkBenchV3, NetworkTestV3, NodePersistentStorageV3, NodePersistentStorageV3.NodePersistentStorageEntryV3, ParseSetupV3, ParseSVMLightV3, ParseV3, ProfilerNodeV3, ProfilerNodeV3.ProfilerNodeEntryV3, ProfilerV3, RapidsHelpV3, RapidsHelpV3.RapidsExpressionV3, RapidsSchemaV3, RapidsV99, RemoveAllV3, RemoveV3, RouteV3, SchemaMetadataV3, ShutdownV3, SplitFrameV3, StreamingSchema, TabulateV3, TimelineV3, TimelineV3.EventV3, TwoDimTableV3, TwoDimTableV3.ColumnSpecsBase, TypeaheadV3, UnlockKeysV3, ValidationMessageV3, VarImpV3, WaterMeterCpuTicksV3, WaterMeterIo.IoStatsEntry, WaterMeterIoV3

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

Base Schema class for all v3 REST API requests, gathering up common behavior such as __meta field and the __exclude_fields/__include_fields query params.

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.

Field Summary

Fields

Modifier and Type	Field and Description
SchemaV3.Meta	__meta
java.lang.String	_exclude_fields

Constructor Summary

Constructors

Constructor and Description
SchemaV3()
SchemaV3(I impl)

Method Summary

Methods

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

_exclude_fields

@API(help="Comma-separated list of JSON field paths to exclude from the result, used like: \"/3/Frames?_exclude_fields=frames/frame_id/URL,__meta\"",
     direction=INPUT)
public java.lang.String _exclude_fields

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.