Package io.openems.common.jsonrpc.request

Class GetEdgesRequest

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.AbstractJsonrpcRequest

io.openems.common.jsonrpc.base.JsonrpcRequest

io.openems.common.jsonrpc.request.GetEdgesRequest

public class GetEdgesRequest
extends JsonrpcRequest

JSON-RPC Request for getting a edges with a GetEdgesRequest.PaginationOptions.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "getEdges",
   "params": {
     "edgeId": string
     "query": string,
     "page": int,
     "limit": int,
     "searchParams": {
       "productTypes?": string[], -- if omitted or empty searches for all
       "sumStates?": Level[], -- if omitted or empty searches for all
       "isOnline?": boolean -- if omitted searches for both
     }
   }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetEdgesRequest.PaginationOptions

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METHOD

Fields inherited from class io.openems.common.jsonrpc.base.JsonrpcRequest

DEFAULT_TIMEOUT_SECONDS, id, NO_TIMEOUT, timeoutOpt

Fields inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage

JSONRPC_VERSION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GetEdgesRequest(JsonrpcRequest request, GetEdgesRequest.PaginationOptions paginationOptions)

Method Summary

Modifier and Type	Method	Description
static GetEdgesRequest	from(JsonrpcRequest request)	Creates a GetEdgesRequest from a JsonrpcRequest.
GetEdgesRequest.PaginationOptions	getPaginationOptions()
com.google.gson.JsonObject	getParams()	Gets the params JsonObject of the JsonrpcRequest.

Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcRequest

getId, getTimeout, toJsonObject

Methods inherited from class io.openems.common.jsonrpc.base.AbstractJsonrpcRequest

getFullyQualifiedMethod, getMethod

Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage

from, from, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

METHOD

public static final String METHOD

See Also:

• Constant Field Values

Constructor Details

GetEdgesRequest

protected GetEdgesRequest(JsonrpcRequest request,
 GetEdgesRequest.PaginationOptions paginationOptions)

Method Details

from

public static GetEdgesRequest from(JsonrpcRequest request)
                            throws OpenemsError.OpenemsNamedException

Creates a GetEdgesRequest from a JsonrpcRequest.

Parameters:

request - the JsonrpcRequest

Returns:

the GetEdgesRequest

Throws:

OpenemsError.OpenemsNamedException - on parse error

getPaginationOptions

public GetEdgesRequest.PaginationOptions getPaginationOptions()

getParams

public com.google.gson.JsonObject getParams()

Description copied from class: AbstractJsonrpcRequest

Gets the params JsonObject of the JsonrpcRequest.

Specified by:

getParams in class AbstractJsonrpcRequest

Returns:

the params as JsonObject