water.api.schemas3

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

java.lang.Object

water.Iced

water.api.Schema<I,S>

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

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

FrameSynopsisV3, FrameV3

public class FrameBaseV3<I extends Iced,S extends FrameBaseV3<I,S>>
extends RequestSchemaV3<I,S>

The minimal amount of information on a Frame.

See Also:

FramesHandler#list(int, FramesV3), Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class water.api.schemas3.SchemaV3

SchemaV3.Meta

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

Schema.AutoParseable

Field Summary

Fields

Modifier and Type	Field and Description
Frame	_fr
long	byte_size
KeyV3.FrameKeyV3	frame_id
boolean	is_text

Fields inherited from class water.api.schemas3.RequestSchemaV3

_exclude_fields

Fields inherited from class water.api.schemas3.SchemaV3

__meta

Constructor Summary

Constructors

Constructor and Description
FrameBaseV3()

Method Summary

Methods inherited from class water.api.schemas3.SchemaV3

writeJSON

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

_fr

public transient Frame _fr

frame_id

@API(help="Frame ID",
     required=true,
     direction=INOUT)
public KeyV3.FrameKeyV3 frame_id

byte_size

@API(help="Total data size in bytes",
     direction=OUTPUT)
public long byte_size

is_text

@API(help="Is this Frame raw unparsed data?",
     direction=OUTPUT)
public boolean is_text

Constructor Detail

FrameBaseV3

public FrameBaseV3()