water.bindings.proxies.retrofit

Interface Sessions

public interface Sessions

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<InitIDV3>	endSession(java.lang.String session_key)
retrofit2.Call<InitIDV3>	endSession(java.lang.String session_key, java.lang.String _exclude_fields) Close the Rapids session.
retrofit2.Call<SessionIdV4>	newSession4()
retrofit2.Call<SessionIdV4>	newSession4(java.lang.String _fields) Start a new Rapids session, and return the session id.

Method Detail

newSession4

@FormUrlEncoded
 @POST(value="/4/sessions")
retrofit2.Call<SessionIdV4> newSession4(@Field(value="_fields")
                                                                                    java.lang.String _fields)

Start a new Rapids session, and return the session id.

Parameters:

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

newSession4

@FormUrlEncoded
 @POST(value="/4/sessions")
retrofit2.Call<SessionIdV4> newSession4()

endSession

@DELETE(value="/4/sessions/{session_key}")
retrofit2.Call<InitIDV3> endSession(@Path(value="session_key")
                                                                               java.lang.String session_key,
                                                                               @Field(value="_exclude_fields")
                                                                               java.lang.String _exclude_fields)

Close the Rapids session.

Parameters:

session_key - Session ID

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

endSession

@DELETE(value="/4/sessions/{session_key}")
retrofit2.Call<InitIDV3> endSession(@Path(value="session_key")
                                                                               java.lang.String session_key)