water.bindings.proxies.retrofit

Interface Frames

public interface Frames

Method Summary

Methods

Modifier and Type	Method and Description
retrofit2.Call<FramesV3>	column(java.lang.String frame_id, java.lang.String column)
retrofit2.Call<FramesV3>	column(java.lang.String frame_id, java.lang.String column, long row_offset, int row_count, int column_offset, int column_count, boolean find_compatible_models, java.lang.String path, boolean force, int num_parts, java.lang.String _exclude_fields) Return the specified column from a Frame.
retrofit2.Call<FramesV3>	columnDomain(java.lang.String frame_id, java.lang.String column)
retrofit2.Call<FramesV3>	columnDomain(java.lang.String frame_id, java.lang.String column, long row_offset, int row_count, int column_offset, int column_count, boolean find_compatible_models, java.lang.String path, boolean force, int num_parts, java.lang.String _exclude_fields) Return the domains for the specified categorical column ("null" if the column is not a categorical).
retrofit2.Call<FramesV3>	columns(java.lang.String frame_id)
retrofit2.Call<FramesV3>	columns(java.lang.String frame_id, java.lang.String column, long row_offset, int row_count, int column_offset, int column_count, boolean find_compatible_models, java.lang.String path, boolean force, int num_parts, java.lang.String _exclude_fields) Return all the columns from a Frame.
retrofit2.Call<FramesV3>	columnSummary(java.lang.String frame_id, java.lang.String column)
retrofit2.Call<FramesV3>	columnSummary(java.lang.String frame_id, java.lang.String column, long row_offset, int row_count, int column_offset, int column_count, boolean find_compatible_models, java.lang.String path, boolean force, int num_parts, java.lang.String _exclude_fields) Return the summary metrics for a column, e.g.
retrofit2.Call<JobV4>	createSimpleFrame()
retrofit2.Call<JobV4>	createSimpleFrame(java.lang.String dest, long seed, int nrows, int ncols_real, int ncols_int, int ncols_enum, int ncols_bool, int ncols_str, int ncols_time, double real_lb, double real_ub, int int_lb, int int_ub, int enum_nlevels, double bool_p, long time_lb, long time_ub, int str_length, double missing_fraction, SimpleRecipeResponseType response_type, double response_lb, double response_ub, double response_p, int response_nlevels, java.lang.String _fields) Create frame with random (uniformly distributed) data.
retrofit2.Call<FramesV3>	delete(java.lang.String frame_id)
retrofit2.Call<FramesV3>	delete(java.lang.String frame_id, java.lang.String column, long row_offset, int row_count, int column_offset, int column_count, boolean find_compatible_models, java.lang.String path, boolean force, int num_parts, java.lang.String _exclude_fields) Delete the specified Frame from the H2O distributed K/V store.
retrofit2.Call<FramesV3>	deleteAll()
retrofit2.Call<FramesV3>	deleteAll(java.lang.String frame_id, java.lang.String column, long row_offset, int row_count, int column_offset, int column_count, boolean find_compatible_models, java.lang.String path, boolean force, int num_parts, java.lang.String _exclude_fields) Delete all Frames from the H2O distributed K/V store.
retrofit2.Call<FramesV3>	export(java.lang.String frame_id)
retrofit2.Call<FramesV3>	export(java.lang.String frame_id, java.lang.String column, long row_offset, int row_count, int column_offset, int column_count, boolean find_compatible_models, java.lang.String path, boolean force, int num_parts, java.lang.String _exclude_fields) Export a Frame to the given path with optional overwrite.
retrofit2.Call<FramesV3>	fetch(java.lang.String frame_id)
retrofit2.Call<FramesV3>	fetch(java.lang.String frame_id, java.lang.String column, long row_offset, int row_count, int column_offset, int column_count, boolean find_compatible_models, java.lang.String path, boolean force, int num_parts, java.lang.String _exclude_fields) Return the specified Frame.
retrofit2.Call<FramesV3>	list()
retrofit2.Call<FramesV3>	list(java.lang.String frame_id, java.lang.String column, long row_offset, int row_count, int column_offset, int column_count, boolean find_compatible_models, java.lang.String path, boolean force, int num_parts, java.lang.String _exclude_fields) Return all Frames in the H2O distributed K/V store.
retrofit2.Call<FramesV3>	summary(java.lang.String frame_id)
retrofit2.Call<FramesV3>	summary(java.lang.String frame_id, java.lang.String column, long row_offset, int row_count, int column_offset, int column_count, boolean find_compatible_models, java.lang.String path, boolean force, int num_parts, java.lang.String _exclude_fields) Return a Frame, including the histograms, after forcing computation of rollups.

Method Detail

createSimpleFrame

@FormUrlEncoded
@POST(value="/4/Frames/$simple")
retrofit2.Call<JobV4> createSimpleFrame(@Field(value="dest")
                                                          java.lang.String dest,
                                                          @Field(value="seed")
                                                          long seed,
                                                          @Field(value="nrows")
                                                          int nrows,
                                                          @Field(value="ncols_real")
                                                          int ncols_real,
                                                          @Field(value="ncols_int")
                                                          int ncols_int,
                                                          @Field(value="ncols_enum")
                                                          int ncols_enum,
                                                          @Field(value="ncols_bool")
                                                          int ncols_bool,
                                                          @Field(value="ncols_str")
                                                          int ncols_str,
                                                          @Field(value="ncols_time")
                                                          int ncols_time,
                                                          @Field(value="real_lb")
                                                          double real_lb,
                                                          @Field(value="real_ub")
                                                          double real_ub,
                                                          @Field(value="int_lb")
                                                          int int_lb,
                                                          @Field(value="int_ub")
                                                          int int_ub,
                                                          @Field(value="enum_nlevels")
                                                          int enum_nlevels,
                                                          @Field(value="bool_p")
                                                          double bool_p,
                                                          @Field(value="time_lb")
                                                          long time_lb,
                                                          @Field(value="time_ub")
                                                          long time_ub,
                                                          @Field(value="str_length")
                                                          int str_length,
                                                          @Field(value="missing_fraction")
                                                          double missing_fraction,
                                                          @Field(value="response_type")
                                                          SimpleRecipeResponseType response_type,
                                                          @Field(value="response_lb")
                                                          double response_lb,
                                                          @Field(value="response_ub")
                                                          double response_ub,
                                                          @Field(value="response_p")
                                                          double response_p,
                                                          @Field(value="response_nlevels")
                                                          int response_nlevels,
                                                          @Field(value="_fields")
                                                          java.lang.String _fields)

Create frame with random (uniformly distributed) data. You can specify how many columns of each type to make; and what the desired range for each column type.

Parameters:

dest - Id for the frame to be created.

seed - Random number seed that determines the random values.

nrows - Number of rows.

ncols_real - Number of real-valued columns. Values in these columns will be uniformly distributed between real_lb and real_ub.

ncols_int - Number of integer columns.

ncols_enum - Number of enum (categorical) columns.

ncols_bool - Number of boolean (binary) columns.

ncols_str - Number of string columns.

ncols_time - Number of time columns.

real_lb - Lower bound for the range of the real-valued columns.

real_ub - Upper bound for the range of the real-valued columns.

int_lb - Lower bound for the range of integer columns.

int_ub - Upper bound for the range of integer columns.

enum_nlevels - Number of levels (categories) for the enum columns.

bool_p - Fraction of ones in each boolean (binary) column.

time_lb - Lower bound for the range of time columns (in ms since the epoch).

time_ub - Upper bound for the range of time columns (in ms since the epoch).

str_length - Length of generated strings in string columns.

missing_fraction - Fraction of missing values.

response_type - Type of the response column to add.

response_lb - Lower bound for the response variable (real/int/time types).

response_ub - Upper bound for the response variable (real/int/time types).

response_p - Frequency of 1s for the bool (binary) response column.

response_nlevels - Number of categorical levels for the enum response column.

_fields - Filter on the set of output fields: if you set _fields="foo,bar,baz", then only those fields will be included in the output; or you can specify _fields="-goo,gee" to include all fields except goo and gee. If the result contains nested data structures, then you can refer to the fields within those structures as well. For example if you specify _fields="foo(oof),bar(-rab)", then only fields foo and bar will be included, and within foo there will be only field oof, whereas within bar all fields except rab will be reported.

createSimpleFrame

@FormUrlEncoded
@POST(value="/4/Frames/$simple")
retrofit2.Call<JobV4> createSimpleFrame()

export

@FormUrlEncoded
@POST(value="/3/Frames/{frame_id}/export")
retrofit2.Call<FramesV3> export(@Path(value="frame_id")
                                                  java.lang.String frame_id,
                                                  @Field(value="column")
                                                  java.lang.String column,
                                                  @Field(value="row_offset")
                                                  long row_offset,
                                                  @Field(value="row_count")
                                                  int row_count,
                                                  @Field(value="column_offset")
                                                  int column_offset,
                                                  @Field(value="column_count")
                                                  int column_count,
                                                  @Field(value="find_compatible_models")
                                                  boolean find_compatible_models,
                                                  @Field(value="path")
                                                  java.lang.String path,
                                                  @Field(value="force")
                                                  boolean force,
                                                  @Field(value="num_parts")
                                                  int num_parts,
                                                  @Field(value="_exclude_fields")
                                                  java.lang.String _exclude_fields)

Export a Frame to the given path with optional overwrite.

Parameters:

frame_id - Name of Frame of interest

column - Name of column of interest

row_offset - Row offset to return

row_count - Number of rows to return

column_offset - Column offset to return

column_count - Number of columns to return

find_compatible_models - Find and return compatible models?

path - File output path

force - Overwrite existing file

num_parts - Number of part files to use (1=single file,-1=automatic)

_exclude_fields - Comma-separated list of JSON field paths to exclude from the result, used like: "/3/Frames?_exclude_fields=frames/frame_id/URL,__meta"

export

@FormUrlEncoded
@POST(value="/3/Frames/{frame_id}/export")
retrofit2.Call<FramesV3> export(@Path(value="frame_id")
                                                  java.lang.String frame_id)

columnSummary

@GET(value="/3/Frames/{frame_id}/columns/{column}/summary")
retrofit2.Call<FramesV3> columnSummary(@Path(value="frame_id")
                                         java.lang.String frame_id,
                                         @Path(value="column")
                                         java.lang.String column,
                                         @Field(value="row_offset")
                                         long row_offset,
                                         @Field(value="row_count")
                                         int row_count,
                                         @Field(value="column_offset")
                                         int column_offset,
                                         @Field(value="column_count")
                                         int column_count,
                                         @Field(value="find_compatible_models")
                                         boolean find_compatible_models,
                                         @Field(value="path")
                                         java.lang.String path,
                                         @Field(value="force")
                                         boolean force,
                                         @Field(value="num_parts")
                                         int num_parts,
                                         @Field(value="_exclude_fields")
                                         java.lang.String _exclude_fields)

Return the summary metrics for a column, e.g. min, max, mean, sigma, percentiles, etc.

Parameters:

frame_id - Name of Frame of interest

column - Name of column of interest

row_offset - Row offset to return

row_count - Number of rows to return

column_offset - Column offset to return

column_count - Number of columns to return

find_compatible_models - Find and return compatible models?

path - File output path

force - Overwrite existing file

num_parts - Number of part files to use (1=single file,-1=automatic)

_exclude_fields - Comma-separated list of JSON field paths to exclude from the result, used like: "/3/Frames?_exclude_fields=frames/frame_id/URL,__meta"

columnSummary

@GET(value="/3/Frames/{frame_id}/columns/{column}/summary")
retrofit2.Call<FramesV3> columnSummary(@Path(value="frame_id")
                                         java.lang.String frame_id,
                                         @Path(value="column")
                                         java.lang.String column)

columnDomain

@GET(value="/3/Frames/{frame_id}/columns/{column}/domain")
retrofit2.Call<FramesV3> columnDomain(@Path(value="frame_id")
                                        java.lang.String frame_id,
                                        @Path(value="column")
                                        java.lang.String column,
                                        @Field(value="row_offset")
                                        long row_offset,
                                        @Field(value="row_count")
                                        int row_count,
                                        @Field(value="column_offset")
                                        int column_offset,
                                        @Field(value="column_count")
                                        int column_count,
                                        @Field(value="find_compatible_models")
                                        boolean find_compatible_models,
                                        @Field(value="path")
                                        java.lang.String path,
                                        @Field(value="force")
                                        boolean force,
                                        @Field(value="num_parts")
                                        int num_parts,
                                        @Field(value="_exclude_fields")
                                        java.lang.String _exclude_fields)

Return the domains for the specified categorical column ("null" if the column is not a categorical).

Parameters:

frame_id - Name of Frame of interest

column - Name of column of interest

row_offset - Row offset to return

row_count - Number of rows to return

column_offset - Column offset to return

column_count - Number of columns to return

find_compatible_models - Find and return compatible models?

path - File output path

force - Overwrite existing file

num_parts - Number of part files to use (1=single file,-1=automatic)

_exclude_fields - Comma-separated list of JSON field paths to exclude from the result, used like: "/3/Frames?_exclude_fields=frames/frame_id/URL,__meta"

columnDomain

@GET(value="/3/Frames/{frame_id}/columns/{column}/domain")
retrofit2.Call<FramesV3> columnDomain(@Path(value="frame_id")
                                        java.lang.String frame_id,
                                        @Path(value="column")
                                        java.lang.String column)

column

@GET(value="/3/Frames/{frame_id}/columns/{column}")
retrofit2.Call<FramesV3> column(@Path(value="frame_id")
                                  java.lang.String frame_id,
                                  @Path(value="column")
                                  java.lang.String column,
                                  @Field(value="row_offset")
                                  long row_offset,
                                  @Field(value="row_count")
                                  int row_count,
                                  @Field(value="column_offset")
                                  int column_offset,
                                  @Field(value="column_count")
                                  int column_count,
                                  @Field(value="find_compatible_models")
                                  boolean find_compatible_models,
                                  @Field(value="path")
                                  java.lang.String path,
                                  @Field(value="force")
                                  boolean force,
                                  @Field(value="num_parts")
                                  int num_parts,
                                  @Field(value="_exclude_fields")
                                  java.lang.String _exclude_fields)

Return the specified column from a Frame.

Parameters:

frame_id - Name of Frame of interest

column - Name of column of interest

row_offset - Row offset to return

row_count - Number of rows to return

column_offset - Column offset to return

column_count - Number of columns to return

find_compatible_models - Find and return compatible models?

path - File output path

force - Overwrite existing file

num_parts - Number of part files to use (1=single file,-1=automatic)

_exclude_fields - Comma-separated list of JSON field paths to exclude from the result, used like: "/3/Frames?_exclude_fields=frames/frame_id/URL,__meta"

column

@GET(value="/3/Frames/{frame_id}/columns/{column}")
retrofit2.Call<FramesV3> column(@Path(value="frame_id")
                                  java.lang.String frame_id,
                                  @Path(value="column")
                                  java.lang.String column)

columns

@GET(value="/3/Frames/{frame_id}/columns")
retrofit2.Call<FramesV3> columns(@Path(value="frame_id")
                                   java.lang.String frame_id,
                                   @Field(value="column")
                                   java.lang.String column,
                                   @Field(value="row_offset")
                                   long row_offset,
                                   @Field(value="row_count")
                                   int row_count,
                                   @Field(value="column_offset")
                                   int column_offset,
                                   @Field(value="column_count")
                                   int column_count,
                                   @Field(value="find_compatible_models")
                                   boolean find_compatible_models,
                                   @Field(value="path")
                                   java.lang.String path,
                                   @Field(value="force")
                                   boolean force,
                                   @Field(value="num_parts")
                                   int num_parts,
                                   @Field(value="_exclude_fields")
                                   java.lang.String _exclude_fields)

Return all the columns from a Frame.

Parameters:

frame_id - Name of Frame of interest

column - Name of column of interest

row_offset - Row offset to return

row_count - Number of rows to return

column_offset - Column offset to return

column_count - Number of columns to return

find_compatible_models - Find and return compatible models?

path - File output path

force - Overwrite existing file

num_parts - Number of part files to use (1=single file,-1=automatic)

_exclude_fields - Comma-separated list of JSON field paths to exclude from the result, used like: "/3/Frames?_exclude_fields=frames/frame_id/URL,__meta"

columns

@GET(value="/3/Frames/{frame_id}/columns")
retrofit2.Call<FramesV3> columns(@Path(value="frame_id")
                                   java.lang.String frame_id)

summary

@GET(value="/3/Frames/{frame_id}/summary")
retrofit2.Call<FramesV3> summary(@Path(value="frame_id")
                                   java.lang.String frame_id,
                                   @Field(value="column")
                                   java.lang.String column,
                                   @Field(value="row_offset")
                                   long row_offset,
                                   @Field(value="row_count")
                                   int row_count,
                                   @Field(value="column_offset")
                                   int column_offset,
                                   @Field(value="column_count")
                                   int column_count,
                                   @Field(value="find_compatible_models")
                                   boolean find_compatible_models,
                                   @Field(value="path")
                                   java.lang.String path,
                                   @Field(value="force")
                                   boolean force,
                                   @Field(value="num_parts")
                                   int num_parts,
                                   @Field(value="_exclude_fields")
                                   java.lang.String _exclude_fields)

Return a Frame, including the histograms, after forcing computation of rollups.

Parameters:

frame_id - Name of Frame of interest

column - Name of column of interest

row_offset - Row offset to return

row_count - Number of rows to return

column_offset - Column offset to return

column_count - Number of columns to return

find_compatible_models - Find and return compatible models?

path - File output path

force - Overwrite existing file

num_parts - Number of part files to use (1=single file,-1=automatic)

_exclude_fields - Comma-separated list of JSON field paths to exclude from the result, used like: "/3/Frames?_exclude_fields=frames/frame_id/URL,__meta"

summary

@GET(value="/3/Frames/{frame_id}/summary")
retrofit2.Call<FramesV3> summary(@Path(value="frame_id")
                                   java.lang.String frame_id)

fetch

@GET(value="/3/Frames/{frame_id}")
retrofit2.Call<FramesV3> fetch(@Path(value="frame_id")
                                 java.lang.String frame_id,
                                 @Field(value="column")
                                 java.lang.String column,
                                 @Field(value="row_offset")
                                 long row_offset,
                                 @Field(value="row_count")
                                 int row_count,
                                 @Field(value="column_offset")
                                 int column_offset,
                                 @Field(value="column_count")
                                 int column_count,
                                 @Field(value="find_compatible_models")
                                 boolean find_compatible_models,
                                 @Field(value="path")
                                 java.lang.String path,
                                 @Field(value="force")
                                 boolean force,
                                 @Field(value="num_parts")
                                 int num_parts,
                                 @Field(value="_exclude_fields")
                                 java.lang.String _exclude_fields)

Return the specified Frame.

Parameters:

frame_id - Name of Frame of interest

column - Name of column of interest

row_offset - Row offset to return

row_count - Number of rows to return

column_offset - Column offset to return

column_count - Number of columns to return

find_compatible_models - Find and return compatible models?

path - File output path

force - Overwrite existing file

num_parts - Number of part files to use (1=single file,-1=automatic)

_exclude_fields - Comma-separated list of JSON field paths to exclude from the result, used like: "/3/Frames?_exclude_fields=frames/frame_id/URL,__meta"

fetch

@GET(value="/3/Frames/{frame_id}")
retrofit2.Call<FramesV3> fetch(@Path(value="frame_id")
                                 java.lang.String frame_id)

list

@GET(value="/3/Frames")
retrofit2.Call<FramesV3> list(@Field(value="frame_id")
                                java.lang.String frame_id,
                                @Field(value="column")
                                java.lang.String column,
                                @Field(value="row_offset")
                                long row_offset,
                                @Field(value="row_count")
                                int row_count,
                                @Field(value="column_offset")
                                int column_offset,
                                @Field(value="column_count")
                                int column_count,
                                @Field(value="find_compatible_models")
                                boolean find_compatible_models,
                                @Field(value="path")
                                java.lang.String path,
                                @Field(value="force")
                                boolean force,
                                @Field(value="num_parts")
                                int num_parts,
                                @Field(value="_exclude_fields")
                                java.lang.String _exclude_fields)

Return all Frames in the H2O distributed K/V store.

Parameters:

frame_id - Name of Frame of interest

column - Name of column of interest

row_offset - Row offset to return

row_count - Number of rows to return

column_offset - Column offset to return

column_count - Number of columns to return

find_compatible_models - Find and return compatible models?

path - File output path

force - Overwrite existing file

num_parts - Number of part files to use (1=single file,-1=automatic)

_exclude_fields - Comma-separated list of JSON field paths to exclude from the result, used like: "/3/Frames?_exclude_fields=frames/frame_id/URL,__meta"

list

@GET(value="/3/Frames")
retrofit2.Call<FramesV3> list()

delete

@DELETE(value="/3/Frames/{frame_id}")
retrofit2.Call<FramesV3> delete(@Path(value="frame_id")
                                     java.lang.String frame_id,
                                     @Field(value="column")
                                     java.lang.String column,
                                     @Field(value="row_offset")
                                     long row_offset,
                                     @Field(value="row_count")
                                     int row_count,
                                     @Field(value="column_offset")
                                     int column_offset,
                                     @Field(value="column_count")
                                     int column_count,
                                     @Field(value="find_compatible_models")
                                     boolean find_compatible_models,
                                     @Field(value="path")
                                     java.lang.String path,
                                     @Field(value="force")
                                     boolean force,
                                     @Field(value="num_parts")
                                     int num_parts,
                                     @Field(value="_exclude_fields")
                                     java.lang.String _exclude_fields)

Delete the specified Frame from the H2O distributed K/V store.

Parameters:

frame_id - Name of Frame of interest

column - Name of column of interest

row_offset - Row offset to return

row_count - Number of rows to return

column_offset - Column offset to return

column_count - Number of columns to return

find_compatible_models - Find and return compatible models?

path - File output path

force - Overwrite existing file

num_parts - Number of part files to use (1=single file,-1=automatic)

_exclude_fields - Comma-separated list of JSON field paths to exclude from the result, used like: "/3/Frames?_exclude_fields=frames/frame_id/URL,__meta"

delete

@DELETE(value="/3/Frames/{frame_id}")
retrofit2.Call<FramesV3> delete(@Path(value="frame_id")
                                     java.lang.String frame_id)

deleteAll

@DELETE(value="/3/Frames")
retrofit2.Call<FramesV3> deleteAll(@Field(value="frame_id")
                                        java.lang.String frame_id,
                                        @Field(value="column")
                                        java.lang.String column,
                                        @Field(value="row_offset")
                                        long row_offset,
                                        @Field(value="row_count")
                                        int row_count,
                                        @Field(value="column_offset")
                                        int column_offset,
                                        @Field(value="column_count")
                                        int column_count,
                                        @Field(value="find_compatible_models")
                                        boolean find_compatible_models,
                                        @Field(value="path")
                                        java.lang.String path,
                                        @Field(value="force")
                                        boolean force,
                                        @Field(value="num_parts")
                                        int num_parts,
                                        @Field(value="_exclude_fields")
                                        java.lang.String _exclude_fields)

Delete all Frames from the H2O distributed K/V store.

Parameters:

frame_id - Name of Frame of interest

column - Name of column of interest

row_offset - Row offset to return

row_count - Number of rows to return

column_offset - Column offset to return

column_count - Number of columns to return

find_compatible_models - Find and return compatible models?

path - File output path

force - Overwrite existing file

num_parts - Number of part files to use (1=single file,-1=automatic)

_exclude_fields - Comma-separated list of JSON field paths to exclude from the result, used like: "/3/Frames?_exclude_fields=frames/frame_id/URL,__meta"

deleteAll

@DELETE(value="/3/Frames")
retrofit2.Call<FramesV3> deleteAll()