Class CreateComponentConfigRequest
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.CreateComponentConfigRequest
Represents a JSON-RPC Request for 'createComponentConfig'.
{ "jsonrpc": "2.0", "id": "UUID", "method": "createComponentConfig", "params": { "factoryPid": string, "properties": [{ "name": string, "value": any }] } }
-
Field Summary
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
ConstructorDescriptionCreateComponentConfigRequest
(String factoryPid, List<UpdateComponentConfigRequest.Property> properties) -
Method Summary
Modifier and TypeMethodDescriptionstatic CreateComponentConfigRequest
from
(com.google.gson.JsonObject params) CreateCreateComponentConfigRequest
from aJsonObject
.static CreateComponentConfigRequest
CreateCreateComponentConfigRequest
from a templateJsonrpcRequest
.Gets the Component-ID, or empty String if none is given.Gets the Factory-PID.com.google.gson.JsonObject
Gets the paramsJsonObject
of theJsonrpcRequest
.Gets the 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, toString
-
Field Details
-
METHOD
- See Also:
-
-
Constructor Details
-
CreateComponentConfigRequest
public CreateComponentConfigRequest(String factoryPid, List<UpdateComponentConfigRequest.Property> properties)
-
-
Method Details
-
from
public static CreateComponentConfigRequest from(JsonrpcRequest r) throws OpenemsError.OpenemsNamedException CreateCreateComponentConfigRequest
from a templateJsonrpcRequest
.- Parameters:
r
- the templateJsonrpcRequest
- Returns:
- the
CreateComponentConfigRequest
- Throws:
OpenemsError.OpenemsNamedException
- on parse error
-
from
public static CreateComponentConfigRequest from(com.google.gson.JsonObject params) throws OpenemsError.OpenemsNamedException CreateCreateComponentConfigRequest
from aJsonObject
.- Parameters:
params
- theJsonObject
- Returns:
- the
CreateComponentConfigRequest
- 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
-
getFactoryPid
Gets the Factory-PID.- Returns:
- Factory-PID
-
getComponentId
Gets the Component-ID, or empty String if none is given.- Returns:
- Component-ID
-
getProperties
Gets the List of Properties.- Returns:
- Properties
-