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) Return the specified column from a Frame.
retrofit2.Call<FramesV3>	columnDomain(java.lang.String frame_id, java.lang.String column) Return the domains for the specified column.
retrofit2.Call<FramesV3>	columns(java.lang.String frame_id) Return all the columns from a Frame.
retrofit2.Call<FramesV3>	columnSummary(java.lang.String frame_id, java.lang.String column) Return the summary metrics for a column, e.g.
retrofit2.Call<FramesV3>	delete(java.lang.String frame_id) Delete the specified Frame from the H2O distributed K/V store.
retrofit2.Call<FramesV3>	deleteAll() Delete all Frames from the H2O distributed K/V store.
retrofit2.Call<FramesV3>	export(java.lang.String frame_id, java.lang.String path, boolean force) Export a Frame to the given path with optional overwrite.
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, java.lang.String _exclude_fields) Export a Frame to the given path with optional overwrite.
retrofit2.Call<FramesV3>	fetch(java.lang.String frame_id) Return the specified Frame.
retrofit2.Call<FramesV3>	list() Return all Frames in the H2O distributed K/V store.
retrofit2.Call<FramesV3>	summary(java.lang.String frame_id) Return a Frame, including the histograms, after forcing computation of rollups.

Method Detail

export

@GET(value="/3/Frames/{frame_id}/export/{path}/overwrite/{force}")
retrofit2.Call<FramesV3> export(@Path(value="frame_id")
                                  java.lang.String frame_id,
                                  @Path(value="path")
                                  java.lang.String path,
                                  @Path(value="force")
                                  boolean force)

Export a Frame to the given path with optional overwrite.

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="_exclude_fields")
                                                  java.lang.String _exclude_fields)

Export a Frame to the given path with optional overwrite.

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)

Return the summary metrics for a column, e.g. mins, maxes, mean, sigma, percentiles, etc.

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)

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

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)

Return the specified column from a Frame.

columns

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

Return all the columns from a Frame.

summary

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

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

fetch

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

Return the specified Frame.

list

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

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

delete

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

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

deleteAll

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

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