water.bindings.proxies.retrofit

Interface Jobs

public interface Jobs

Method Summary

Methods

Modifier and Type	Method and Description
retrofit2.Call<JobsV3>	cancel(java.lang.String job_id)
retrofit2.Call<JobsV3>	cancel(java.lang.String job_id, java.lang.String _exclude_fields) Cancel a running job.
retrofit2.Call<JobsV3>	fetch(java.lang.String job_id)
retrofit2.Call<JobsV3>	fetch(java.lang.String job_id, java.lang.String _exclude_fields) Get the status of the given H2O Job (long-running action).
retrofit2.Call<JobV4>	getJob4(java.lang.String job_id)
retrofit2.Call<JobV4>	getJob4(java.lang.String job_id, java.lang.String _fields) Retrieve information about the current state of a job.
retrofit2.Call<JobsV3>	list()
retrofit2.Call<JobsV3>	list(java.lang.String job_id, java.lang.String _exclude_fields) Get a list of all the H2O Jobs (long-running actions).

Method Detail

list

@GET(value="/3/Jobs")
retrofit2.Call<JobsV3> list(@Field(value="job_id")
                              java.lang.String job_id,
                              @Field(value="_exclude_fields")
                              java.lang.String _exclude_fields)

Get a list of all the H2O Jobs (long-running actions).

Parameters:

job_id - Optional Job identifier

_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/Jobs")
retrofit2.Call<JobsV3> list()

fetch

@GET(value="/3/Jobs/{job_id}")
retrofit2.Call<JobsV3> fetch(@Path(value="job_id")
                               java.lang.String job_id,
                               @Field(value="_exclude_fields")
                               java.lang.String _exclude_fields)

Get the status of the given H2O Job (long-running action).

Parameters:

job_id - Optional Job identifier

_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/Jobs/{job_id}")
retrofit2.Call<JobsV3> fetch(@Path(value="job_id")
                               java.lang.String job_id)

cancel

@FormUrlEncoded
@POST(value="/3/Jobs/{job_id}/cancel")
retrofit2.Call<JobsV3> cancel(@Path(value="job_id")
                                                java.lang.String job_id,
                                                @Field(value="_exclude_fields")
                                                java.lang.String _exclude_fields)

Cancel a running job.

Parameters:

job_id - Optional Job identifier

_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"

cancel

@FormUrlEncoded
@POST(value="/3/Jobs/{job_id}/cancel")
retrofit2.Call<JobsV3> cancel(@Path(value="job_id")
                                                java.lang.String job_id)

getJob4

@GET(value="/4/jobs/{job_id}")
retrofit2.Call<JobV4> getJob4(@Path(value="job_id")
                                java.lang.String job_id,
                                @Field(value="_fields")
                                java.lang.String _fields)

Retrieve information about the current state of a job.

Parameters:

job_id - Id of the job to fetch.

_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.

getJob4

@GET(value="/4/jobs/{job_id}")
retrofit2.Call<JobV4> getJob4(@Path(value="job_id")
                                java.lang.String job_id)