public class FramesV3 extends RequestSchemaV3<FramesHandler.Frames,FramesV3>
SchemaV3.Meta
Schema.AutoParseable
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 |
_exclude_fields
Constructor and Description |
---|
FramesV3() |
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.
|
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
asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonBytes, toJsonString, write, writeExternal
@API(help="Name of Frame of interest", json=false) public KeyV3.FrameKeyV3 frame_id
@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
@API(help="Find and return compatible models?", json=false) public boolean find_compatible_models
@API(help="Number of part files to use (1=single file,-1=automatic)", json=false) public int num_parts
@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
@API(help="Output file format. Defaults to \'csv\'.", values={"csv","parquet"}, json=false) public ExportFileFormat format
@API(help="Compression method (default none; gzip, bzip2 and snappy available depending on runtime environment)") public java.lang.String compression
@API(help="Quote column names in header line (default true)") public boolean quote_header
@API(help="Compatible models", direction=OUTPUT) public ModelSchemaV3[] compatible_models
public FramesHandler.Frames fillImpl(FramesHandler.Frames f)
Schema
fillImpl
in class Schema<FramesHandler.Frames,FramesV3>
public FramesV3 fillFromImpl(FramesHandler.Frames f)
Schema
fillFromImpl
in class Schema<FramesHandler.Frames,FramesV3>