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
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 -
Field Summary
FieldsFields 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
ConstructorsModifierConstructorDescriptionprotected
GetEdgesRequest
(JsonrpcRequest request, GetEdgesRequest.PaginationOptions paginationOptions) -
Method Summary
Modifier and TypeMethodDescriptionstatic GetEdgesRequest
from
(JsonrpcRequest request) Creates aGetEdgesRequest
from aJsonrpcRequest
.com.google.gson.JsonObject
Gets the paramsJsonObject
of theJsonrpcRequest
.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
-
Field Details
-
METHOD
- See Also:
-
-
Constructor Details
-
GetEdgesRequest
protected GetEdgesRequest(JsonrpcRequest request, GetEdgesRequest.PaginationOptions paginationOptions)
-
-
Method Details
-
from
public static GetEdgesRequest from(JsonrpcRequest request) throws OpenemsError.OpenemsNamedException Creates aGetEdgesRequest
from aJsonrpcRequest
.- Parameters:
request
- theJsonrpcRequest
- Returns:
- the
GetEdgesRequest
- Throws:
OpenemsError.OpenemsNamedException
- on parse error
-
getPaginationOptions
-
getParams
public com.google.gson.JsonObject getParams()Description copied from class:AbstractJsonrpcRequest
Gets the paramsJsonObject
of theJsonrpcRequest
.- Specified by:
getParams
in classAbstractJsonrpcRequest
- Returns:
- the params as
JsonObject
-