water.api.schemas3

Class ParseSetupV3

java.lang.Object

water.Iced

water.api.Schema<I,S>

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

water.api.schemas3.RequestSchemaV3<ParseSetup,ParseSetupV3>

water.api.schemas3.ParseSetupV3

All Implemented Interfaces:

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

public class ParseSetupV3
extends RequestSchemaV3<ParseSetup,ParseSetupV3>

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
int	check_header
int	chunk_size
int	column_count
java.lang.String	column_name_filter
java.lang.String[]	column_names
int	column_offset
java.lang.String[]	column_types
java.lang.String	custom_non_data_line_markers
java.lang.String[][]	data
KeyV3.DecryptionToolKeyV3	decrypt_tool
java.lang.String	destination_frame
byte	escapechar
boolean	force_col_types
java.lang.String[][]	na_strings
int	number_columns
java.lang.String	parse_type
java.lang.String[]	partition_by
byte	separator
boolean	single_quotes
int[]	skipped_columns
KeyV3.FrameKeyV3[]	source_frames
int	total_filtered_column_count
java.lang.String[]	warnings

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

Method Summary

Modifier and Type	Method and Description
ParseSetupV3	fillFromImpl(ParseSetup impl) Fill this Schema from the given implementation object.
ParseSetup	fillImpl(ParseSetup impl) 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

source_frames

@API(help="Source frames",
     required=true,
     direction=INOUT)
public KeyV3.FrameKeyV3[] source_frames

parse_type

@API(help="Parser type",
     valuesProvider=ParseTypeValuesProvider.class,
     direction=INOUT)
public java.lang.String parse_type

separator

@API(help="Field separator",
     direction=INOUT)
public byte separator

single_quotes

@API(help="Single quotes",
     direction=INOUT)
public boolean single_quotes

check_header

@API(help="Check header: 0 means guess, +1 means 1st line is header not data, -1 means 1st line is data not header",
     direction=INOUT)
public int check_header

column_names

@API(help="Column names",
     direction=INOUT)
public java.lang.String[] column_names

skipped_columns

@API(help="Skipped columns indices",
     direction=INOUT)
public int[] skipped_columns

column_types

@API(help="Value types for columns",
     direction=INOUT)
public java.lang.String[] column_types

na_strings

@API(help="NA strings for columns",
     direction=INOUT)
public java.lang.String[][] na_strings

column_name_filter

@API(help="Regex for names of columns to return",
     direction=INOUT)
public java.lang.String column_name_filter

column_offset

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

column_count

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

destination_frame

@API(help="Suggested name",
     direction=OUTPUT)
public java.lang.String destination_frame

number_columns

@API(help="Number of columns",
     direction=OUTPUT)
public int number_columns

data

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

warnings

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

chunk_size

@API(help="Size of individual parse tasks",
     direction=OUTPUT)
public int chunk_size

total_filtered_column_count

@API(help="Total number of columns we would return with no column pagination",
     direction=INOUT)
public int total_filtered_column_count

custom_non_data_line_markers

@API(help="Custom characters to be treated as non-data line markers",
     direction=INOUT)
public java.lang.String custom_non_data_line_markers

decrypt_tool

@API(help="Key-reference to an initialized instance of a Decryption Tool")
public KeyV3.DecryptionToolKeyV3 decrypt_tool

partition_by

@API(help="Names of the columns the persisted dataset has been partitioned by.",
     direction=INOUT)
public java.lang.String[] partition_by

escapechar

@API(help="One ASCII character used to escape other characters.",
     direction=INOUT)
public byte escapechar

force_col_types

@API(help="If true, will force the column types to be either the ones in Parquet schema for Parquet files or the ones specified in column_types.  This parameter is used for numerical columns only.  Other column settings will happen without setting this parameter.  Defaults to false.",
     direction=INPUT)
public boolean force_col_types

Constructor Detail

ParseSetupV3

public ParseSetupV3()

Method Detail

fillImpl

public ParseSetup fillImpl(ParseSetup impl)

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

fillFromImpl

public ParseSetupV3 fillFromImpl(ParseSetup impl)

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