Class UpdateComponentConfigRequest
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.UpdateComponentConfigRequest
Represents a JSON-RPC Request for 'updateComponentConfig'.
{ "jsonrpc": "2.0", "id": "UUID", "method": "updateComponentConfig", "params": { "componentId": string, "properties": [{ "name": string, "value": any }] } }
-
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
ConstructorsConstructorDescriptionUpdateComponentConfigRequest
(String componentId, List<UpdateComponentConfigRequest.Property> properties) -
Method Summary
Modifier and TypeMethodDescriptionstatic UpdateComponentConfigRequest
CreateUpdateComponentConfigRequest
from a templateJsonrpcRequest
.Gets the Component-ID.com.google.gson.JsonObject
Gets the paramsJsonObject
of theJsonrpcRequest
.Gets a list of Properties.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
-
UpdateComponentConfigRequest
public UpdateComponentConfigRequest(String componentId, List<UpdateComponentConfigRequest.Property> properties)
-
-
Method Details
-
from
public static UpdateComponentConfigRequest from(JsonrpcRequest r) throws OpenemsError.OpenemsNamedException CreateUpdateComponentConfigRequest
from a templateJsonrpcRequest
.- Parameters:
r
- the templateJsonrpcRequest
- Returns:
- the
UpdateComponentConfigRequest
- Throws:
OpenemsError.OpenemsNamedException
- on parse error
-
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
-
getComponentId
Gets the Component-ID.- Returns:
- Component-ID
-
getProperties
Gets a list of Properties.- Returns:
- the Properties
-