Class SetGridConnScheduleRequest
- 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.SetGridConnScheduleRequest
-
public class SetGridConnScheduleRequest extends JsonrpcRequest
Represents a JSON-RPC Request for 'setGridConnSchedule'.{ "jsonrpc": "2.0", "id": "UUID", "method": "setGridConnSchedule", "params": { "id": "edgeId", "schedule": [{ "startTimestamp": 1542464697, // epoch in seconds "duration": 900, // in seconds "activePowerSetPoint": 0 // in Watt }] } }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SetGridConnScheduleRequest.GridConnSchedule
-
Field Summary
Fields Modifier and Type Field Description static java.lang.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 Constructor Description SetGridConnScheduleRequest(java.lang.String edgeId)
SetGridConnScheduleRequest(java.lang.String edgeId, java.util.List<SetGridConnScheduleRequest.GridConnSchedule> schedule)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addScheduleEntry(SetGridConnScheduleRequest.GridConnSchedule scheduleEntry)
Add aSetGridConnScheduleRequest.GridConnSchedule
entry.static SetGridConnScheduleRequest
from(JsonrpcRequest r)
CreateSetGridConnScheduleRequest
from a templateJsonrpcRequest
.java.lang.String
getEdgeId()
Gets the Edge-ID.com.google.gson.JsonObject
getParams()
Gets the paramsJsonObject
of theJsonrpcRequest
.java.util.List<SetGridConnScheduleRequest.GridConnSchedule>
getSchedule()
Gets the list ofSetGridConnScheduleRequest.GridConnSchedule
entries.-
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 Detail
-
METHOD
public static final java.lang.String METHOD
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
SetGridConnScheduleRequest
public SetGridConnScheduleRequest(java.lang.String edgeId)
-
SetGridConnScheduleRequest
public SetGridConnScheduleRequest(java.lang.String edgeId, java.util.List<SetGridConnScheduleRequest.GridConnSchedule> schedule)
-
-
Method Detail
-
from
public static SetGridConnScheduleRequest from(JsonrpcRequest r) throws OpenemsError.OpenemsNamedException
CreateSetGridConnScheduleRequest
from a templateJsonrpcRequest
.- Parameters:
r
- the templateJsonrpcRequest
- Returns:
- the
SetGridConnScheduleRequest
- Throws:
OpenemsError.OpenemsNamedException
- on parse error
-
addScheduleEntry
public void addScheduleEntry(SetGridConnScheduleRequest.GridConnSchedule scheduleEntry)
Add aSetGridConnScheduleRequest.GridConnSchedule
entry.- Parameters:
scheduleEntry
- GridConnSchedule entry
-
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
-
getEdgeId
public java.lang.String getEdgeId()
Gets the Edge-ID.- Returns:
- Edge-ID
-
getSchedule
public java.util.List<SetGridConnScheduleRequest.GridConnSchedule> getSchedule()
Gets the list ofSetGridConnScheduleRequest.GridConnSchedule
entries.- Returns:
- entries
-
-