Class EdgeRpcRequest
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.EdgeRpcRequest
Wraps a JSON-RPC Request for a specific Edge-ID.
{ "jsonrpc": "2.0", "id": "UUID", "method": "edgeRpc", "params": { "edgeId": string, "payload": { } } }
-
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
ConstructorsConstructorDescriptionEdgeRpcRequest
(JsonrpcRequest request, String edgeId, JsonrpcRequest payload) EdgeRpcRequest
(String edgeId, JsonrpcRequest payload) -
Method Summary
Modifier and TypeMethodDescriptionstatic EdgeRpcRequest
CreateEdgeRpcRequest
from a templateJsonrpcRequest
.Gets the Edge-ID.com.google.gson.JsonObject
Gets the paramsJsonObject
of theJsonrpcRequest
.Gets the PayloadJsonrpcRequest
.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
-
EdgeRpcRequest
-
EdgeRpcRequest
-
-
Method Details
-
from
CreateEdgeRpcRequest
from a templateJsonrpcRequest
.- Parameters:
r
- the templateJsonrpcRequest
- Returns:
- the
EdgeRpcRequest
- Throws:
OpenemsError.OpenemsNamedException
- on parse error
-
getEdgeId
Gets the Edge-ID.- Returns:
- Edge-ID
-
getPayload
Gets the PayloadJsonrpcRequest
.- Returns:
- Payload
-
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
-