water.bindings.proxies.retrofit

Interface NodePersistentStorage

public interface NodePersistentStorage

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<NodePersistentStorageV3>	configured()
retrofit2.Call<NodePersistentStorageV3>	configured(java.lang.String category, java.lang.String name, java.lang.String value, java.lang.String _exclude_fields) Return true or false.
retrofit2.Call<NodePersistentStorageV3>	delete(java.lang.String category, java.lang.String name)
retrofit2.Call<NodePersistentStorageV3>	delete(java.lang.String category, java.lang.String name, java.lang.String value, java.lang.String _exclude_fields) Delete a key.
retrofit2.Call<NodePersistentStorageV3>	exists(java.lang.String category, java.lang.String name)
retrofit2.Call<NodePersistentStorageV3>	exists(java.lang.String category, java.lang.String name, java.lang.String value, java.lang.String _exclude_fields) Return true or false.
retrofit2.Call<NodePersistentStorageV3>	get_as_string(java.lang.String category, java.lang.String name)
retrofit2.Call<NodePersistentStorageV3>	get_as_string(java.lang.String category, java.lang.String name, java.lang.String value, java.lang.String _exclude_fields) Return value for a given name.
retrofit2.Call<NodePersistentStorageV3>	list(java.lang.String category)
retrofit2.Call<NodePersistentStorageV3>	list(java.lang.String category, java.lang.String name, java.lang.String value, java.lang.String _exclude_fields) Return all keys stored for a given category.
retrofit2.Call<NodePersistentStorageV3>	put_with_name(java.lang.String category, java.lang.String name)
retrofit2.Call<NodePersistentStorageV3>	put_with_name(java.lang.String category, java.lang.String name, java.lang.String value, java.lang.String _exclude_fields) Store a named value.
retrofit2.Call<NodePersistentStorageV3>	put(java.lang.String category)
retrofit2.Call<NodePersistentStorageV3>	put(java.lang.String category, java.lang.String name, java.lang.String value, java.lang.String _exclude_fields) Store a value.

Method Detail

exists

@GET(value="/3/NodePersistentStorage/categories/{category}/names/{name}/exists")
retrofit2.Call<NodePersistentStorageV3> exists(@Path(value="category")
                                                                                                                                java.lang.String category,
                                                                                                                                @Path(value="name")
                                                                                                                                java.lang.String name,
                                                                                                                                @Field(value="value")
                                                                                                                                java.lang.String value,
                                                                                                                                @Field(value="_exclude_fields")
                                                                                                                                java.lang.String _exclude_fields)

Return true or false.

Parameters:

category - Category name

name - Key name

value - Value

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

exists

@GET(value="/3/NodePersistentStorage/categories/{category}/names/{name}/exists")
retrofit2.Call<NodePersistentStorageV3> exists(@Path(value="category")
                                                                                                                                java.lang.String category,
                                                                                                                                @Path(value="name")
                                                                                                                                java.lang.String name)

configured

@GET(value="/3/NodePersistentStorage/configured")
retrofit2.Call<NodePersistentStorageV3> configured(@Field(value="category")
                                                                                                     java.lang.String category,
                                                                                                     @Field(value="name")
                                                                                                     java.lang.String name,
                                                                                                     @Field(value="value")
                                                                                                     java.lang.String value,
                                                                                                     @Field(value="_exclude_fields")
                                                                                                     java.lang.String _exclude_fields)

Return true or false.

Parameters:

category - Category name

name - Key name

value - Value

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

configured

@GET(value="/3/NodePersistentStorage/configured")
retrofit2.Call<NodePersistentStorageV3> configured()

put_with_name

@FormUrlEncoded
 @POST(value="/3/NodePersistentStorage/{category}/{name}")
retrofit2.Call<NodePersistentStorageV3> put_with_name(@Path(value="category")
                                                                                                                                 java.lang.String category,
                                                                                                                                 @Path(value="name")
                                                                                                                                 java.lang.String name,
                                                                                                                                 @Field(value="value")
                                                                                                                                 java.lang.String value,
                                                                                                                                 @Field(value="_exclude_fields")
                                                                                                                                 java.lang.String _exclude_fields)

Store a named value.

Parameters:

category - Category name

name - Key name

value - Value

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

put_with_name

@FormUrlEncoded
 @POST(value="/3/NodePersistentStorage/{category}/{name}")
retrofit2.Call<NodePersistentStorageV3> put_with_name(@Path(value="category")
                                                                                                                                 java.lang.String category,
                                                                                                                                 @Path(value="name")
                                                                                                                                 java.lang.String name)

get_as_string

@GET(value="/3/NodePersistentStorage/{category}/{name}")
retrofit2.Call<NodePersistentStorageV3> get_as_string(@Path(value="category")
                                                                                                               java.lang.String category,
                                                                                                               @Path(value="name")
                                                                                                               java.lang.String name,
                                                                                                               @Field(value="value")
                                                                                                               java.lang.String value,
                                                                                                               @Field(value="_exclude_fields")
                                                                                                               java.lang.String _exclude_fields)

Return value for a given name.

Parameters:

category - Category name

name - Key name

value - Value

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

get_as_string

@GET(value="/3/NodePersistentStorage/{category}/{name}")
retrofit2.Call<NodePersistentStorageV3> get_as_string(@Path(value="category")
                                                                                                               java.lang.String category,
                                                                                                               @Path(value="name")
                                                                                                               java.lang.String name)

delete

@DELETE(value="/3/NodePersistentStorage/{category}/{name}")
retrofit2.Call<NodePersistentStorageV3> delete(@Path(value="category")
                                                                                                           java.lang.String category,
                                                                                                           @Path(value="name")
                                                                                                           java.lang.String name,
                                                                                                           @Field(value="value")
                                                                                                           java.lang.String value,
                                                                                                           @Field(value="_exclude_fields")
                                                                                                           java.lang.String _exclude_fields)

Delete a key.

Parameters:

category - Category name

name - Key name

value - Value

_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/NodePersistentStorage/{category}/{name}")
retrofit2.Call<NodePersistentStorageV3> delete(@Path(value="category")
                                                                                                           java.lang.String category,
                                                                                                           @Path(value="name")
                                                                                                           java.lang.String name)

put

@FormUrlEncoded
 @POST(value="/3/NodePersistentStorage/{category}")
retrofit2.Call<NodePersistentStorageV3> put(@Path(value="category")
                                                                                                                java.lang.String category,
                                                                                                                @Field(value="name")
                                                                                                                java.lang.String name,
                                                                                                                @Field(value="value")
                                                                                                                java.lang.String value,
                                                                                                                @Field(value="_exclude_fields")
                                                                                                                java.lang.String _exclude_fields)

Store a value.

Parameters:

category - Category name

name - Key name

value - Value

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

put

@FormUrlEncoded
 @POST(value="/3/NodePersistentStorage/{category}")
retrofit2.Call<NodePersistentStorageV3> put(@Path(value="category")
                                                                                                                java.lang.String category)

list

@GET(value="/3/NodePersistentStorage/{category}")
retrofit2.Call<NodePersistentStorageV3> list(@Path(value="category")
                                                                                               java.lang.String category,
                                                                                               @Field(value="name")
                                                                                               java.lang.String name,
                                                                                               @Field(value="value")
                                                                                               java.lang.String value,
                                                                                               @Field(value="_exclude_fields")
                                                                                               java.lang.String _exclude_fields)

Return all keys stored for a given category.

Parameters:

category - Category name

name - Key name

value - Value

_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/NodePersistentStorage/{category}")
retrofit2.Call<NodePersistentStorageV3> list(@Path(value="category")
                                                                                               java.lang.String category)