water.bindings.proxies.retrofit

Interface Capabilities

public interface Capabilities

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<CapabilitiesV3>	listAll()
retrofit2.Call<CapabilitiesV3>	listAll(java.lang.String _exclude_fields) List of all registered capabilities
retrofit2.Call<CapabilitiesV3>	listCore()
retrofit2.Call<CapabilitiesV3>	listCore(java.lang.String _exclude_fields) List registered core capabilities
retrofit2.Call<CapabilitiesV3>	listRest()
retrofit2.Call<CapabilitiesV3>	listRest(java.lang.String _exclude_fields) List of all registered Rest API capabilities

Method Detail

listAll

@GET(value="/3/Capabilities")
retrofit2.Call<CapabilitiesV3> listAll(@Field(value="_exclude_fields")
                                                                     java.lang.String _exclude_fields)

List of all registered capabilities

Parameters:

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

listAll

@GET(value="/3/Capabilities")
retrofit2.Call<CapabilitiesV3> listAll()

listCore

@GET(value="/3/Capabilities/Core")
retrofit2.Call<CapabilitiesV3> listCore(@Field(value="_exclude_fields")
                                                                           java.lang.String _exclude_fields)

List registered core capabilities

Parameters:

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

listCore

@GET(value="/3/Capabilities/Core")
retrofit2.Call<CapabilitiesV3> listCore()

listRest

@GET(value="/3/Capabilities/API")
retrofit2.Call<CapabilitiesV3> listRest(@Field(value="_exclude_fields")
                                                                          java.lang.String _exclude_fields)

List of all registered Rest API capabilities

Parameters:

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

listRest

@GET(value="/3/Capabilities/API")
retrofit2.Call<CapabilitiesV3> listRest()