water.api.schemas4.input

Class CreateFrameSimpleIV4

java.lang.Object

water.Iced

water.api.Schema<I,S>

water.api.schemas4.InputSchemaV4<SimpleCreateFrameRecipe,CreateFrameSimpleIV4>

water.api.schemas4.input.CreateFrameSimpleIV4

All Implemented Interfaces:

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

public class CreateFrameSimpleIV4
extends InputSchemaV4<SimpleCreateFrameRecipe,CreateFrameSimpleIV4>

Input schema for `POST /4/frames/$simple` endpoint.

See Also:

Serialized Form

Nested Class Summary

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

Schema.AutoParseable

Field Summary

Fields

Modifier and Type	Field and Description
double	bool_p
KeyV3.FrameKeyV3	dest
int	enum_nlevels
int	int_lb
int	int_ub
double	missing_fraction
int	ncols_bool
int	ncols_enum
int	ncols_int
int	ncols_real
int	ncols_str
int	ncols_time
int	nrows
double	real_lb
double	real_ub
double	response_lb
int	response_nlevels
double	response_p
SimpleCreateFrameRecipe.ResponseType	response_type
double	response_ub
long	seed
int	str_length
long	time_lb
long	time_ub

Fields inherited from class water.api.schemas4.InputSchemaV4

_fields

Constructor Summary

Constructors

Constructor and Description
CreateFrameSimpleIV4()

Method Summary

Methods inherited from class water.api.Schema

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

Methods inherited from class java.lang.Object

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

Field Detail

dest

@API(help="Id for the frame to be created.")
public KeyV3.FrameKeyV3 dest

seed

@API(help="Random number seed that determines the random values.")
public long seed

nrows

@API(help="Number of rows.")
public int nrows

ncols_real

@API(help="Number of real-valued columns. Values in these columns will be uniformly distributed between real_lb and real_ub.")
public int ncols_real

ncols_int

@API(help="Number of integer columns.")
public int ncols_int

ncols_enum

@API(help="Number of enum (categorical) columns.")
public int ncols_enum

ncols_bool

@API(help="Number of boolean (binary) columns.")
public int ncols_bool

ncols_str

@API(help="Number of string columns.")
public int ncols_str

ncols_time

@API(help="Number of time columns.")
public int ncols_time

real_lb

@API(help="Lower bound for the range of the real-valued columns.")
public double real_lb

real_ub

@API(help="Upper bound for the range of the real-valued columns.")
public double real_ub

int_lb

@API(help="Lower bound for the range of integer columns.")
public int int_lb

int_ub

@API(help="Upper bound for the range of integer columns.")
public int int_ub

enum_nlevels

@API(help="Number of levels (categories) for the enum columns.")
public int enum_nlevels

bool_p

@API(help="Fraction of ones in each boolean (binary) column.")
public double bool_p

time_lb

@API(help="Lower bound for the range of time columns (in ms since the epoch).")
public long time_lb

time_ub

@API(help="Upper bound for the range of time columns (in ms since the epoch).")
public long time_ub

str_length

@API(help="Length of generated strings in string columns.")
public int str_length

missing_fraction

@API(help="Fraction of missing values.")
public double missing_fraction

response_type

@API(help="Type of the response column to add.",
     values={"none","real","int","bool","enum","time"})
public SimpleCreateFrameRecipe.ResponseType response_type

response_lb

@API(help="Lower bound for the response variable (real/int/time types).")
public double response_lb

response_ub

@API(help="Upper bound for the response variable (real/int/time types).")
public double response_ub

response_p

@API(help="Frequency of 1s for the bool (binary) response column.")
public double response_p

response_nlevels

@API(help="Number of categorical levels for the enum response column.")
public int response_nlevels

Constructor Detail

CreateFrameSimpleIV4

public CreateFrameSimpleIV4()