water.api.schemas3

Class FramesV3

java.lang.Object

water.Iced

water.api.Schema<I,S>

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

water.api.schemas3.RequestSchemaV3<FramesHandler.Frames,FramesV3>

water.api.schemas3.FramesV3

All Implemented Interfaces:

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

public class FramesV3
extends RequestSchemaV3<FramesHandler.Frames,FramesV3>

See Also:

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
java.lang.String	column
int	column_count
int	column_offset
ModelSchemaV3[]	compatible_models
java.lang.String	compression
java.lang.String[][]	domain
boolean	find_compatible_models
boolean	force
ExportFileFormat	format
KeyV3.FrameKeyV3	frame_id
FrameV3[]	frames
int	full_column_count
boolean	header
JobV3	job
int	num_parts
boolean	parallel
java.lang.String	path
boolean	quote_header
int	row_count
long	row_offset
byte	separator

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
FramesV3()

Method Summary

Modifier and Type	Method and Description
FramesV3	fillFromImpl(FramesHandler.Frames f) Fill this Schema from the given implementation object.
FramesHandler.Frames	fillImpl(FramesHandler.Frames f) Fill an impl object and any children from this schema and its children.

Methods inherited from class water.api.schemas3.SchemaV3

writeJSON

Methods inherited from class water.api.Schema

createAndFillImpl, createImpl, extractVersionFromSchemaName, fillFromAny, fillFromBody, fillFromImpl, fillFromImpl, fillFromParms, fillFromParms, fillFromParms, 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, toJsonBytes, toJsonString, write, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

frame_id

@API(help="Name of Frame of interest",
     json=false)
public KeyV3.FrameKeyV3 frame_id

column

@API(help="Name of column of interest",
     json=false)
public java.lang.String column

row_offset

@API(help="Row offset to return",
     direction=INOUT)
public long row_offset

row_count

@API(help="Number of rows to return",
     direction=INOUT)
public int row_count

column_offset

@API(help="Column offset to return",
     direction=INOUT)
public int column_offset

full_column_count

@API(help="Number of full columns to return. The columns between full_column_count and column_count will be returned without the data",
     direction=INOUT)
public int full_column_count

column_count

@API(help="Number of columns to return",
     direction=INOUT)
public int column_count

find_compatible_models

@API(help="Find and return compatible models?",
     json=false)
public boolean find_compatible_models

path

@API(help="File output path",
     json=false)
public java.lang.String path

force

@API(help="Overwrite existing file",
     json=false)
public boolean force

num_parts

@API(help="Number of part files to use (1=single file,-1=automatic)",
     json=false)
public int num_parts

parallel

@API(help="Use parallel export to a single file (doesn\'t apply when num_parts != 1, creates temporary files in the destination directory)",
     json=false)
public boolean parallel

format

@API(help="Output file format. Defaults to \'csv\'.",
     values={"csv","parquet"},
     json=false)
public ExportFileFormat format

compression

@API(help="Compression method (default none; gzip, bzip2 and snappy available depending on runtime environment)")
public java.lang.String compression

separator

@API(help="Field separator (default \',\')")
public byte separator

header

@API(help="Use header (default true)")
public boolean header

quote_header

@API(help="Quote column names in header line (default true)")
public boolean quote_header

job

@API(help="Job for export file",
     direction=OUTPUT)
public JobV3 job

frames

@API(help="Frames",
     direction=OUTPUT)
public FrameV3[] frames

compatible_models

@API(help="Compatible models",
     direction=OUTPUT)
public ModelSchemaV3[] compatible_models

domain

@API(help="Domains",
     direction=OUTPUT)
public java.lang.String[][] domain

Constructor Detail

FramesV3

public FramesV3()

Method Detail

fillImpl

public FramesHandler.Frames fillImpl(FramesHandler.Frames f)

Description copied from class: Schema

Fill an impl object and any children from this schema and its children. If a schema doesn't need to adapt any fields if does not need to override this method.

Overrides:

fillImpl in class Schema<FramesHandler.Frames,FramesV3>

fillFromImpl

public FramesV3 fillFromImpl(FramesHandler.Frames f)

Description copied from class: Schema

Fill this Schema from the given implementation object. If a schema doesn't need to adapt any fields if does not need to override this method.

Overrides:

fillFromImpl in class Schema<FramesHandler.Frames,FramesV3>