Package io.openems.common.jsonrpc.request

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

public class UpdateComponentConfigRequest
extends JsonrpcRequest

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

Modifier and Type	Class	Description
static class	UpdateComponentConfigRequest.Property

Field Summary

Fields

Modifier and Type	Field	Description
static final 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
UpdateComponentConfigRequest(String componentId, List<UpdateComponentConfigRequest.Property> properties)

Method Summary

Modifier and Type	Method	Description
static UpdateComponentConfigRequest	from(JsonrpcRequest r)	Create UpdateComponentConfigRequest from a template JsonrpcRequest.
String	getComponentId()	Gets the Component-ID.
com.google.gson.JsonObject	getParams()	Gets the params JsonObject of the JsonrpcRequest.
List<UpdateComponentConfigRequest.Property>	getProperties()	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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

METHOD

public static final String METHOD

See Also:

• Constant Field Values

Constructor Details

UpdateComponentConfigRequest

public UpdateComponentConfigRequest(String componentId,
 List<UpdateComponentConfigRequest.Property> properties)

Method Details

from

public static UpdateComponentConfigRequest from(JsonrpcRequest r)
                                         throws OpenemsError.OpenemsNamedException

Create UpdateComponentConfigRequest from a template JsonrpcRequest.

Parameters:

r - the template JsonrpcRequest

Returns:

the UpdateComponentConfigRequest

Throws:

OpenemsError.OpenemsNamedException - on parse error

getParams

public com.google.gson.JsonObject getParams()

Description copied from class: AbstractJsonrpcRequest

Gets the params JsonObject of the JsonrpcRequest.

Specified by:

getParams in class AbstractJsonrpcRequest

Returns:

the params as JsonObject

getComponentId

public String getComponentId()

Gets the Component-ID.

Returns:

Component-ID

getProperties

public List<UpdateComponentConfigRequest.Property> getProperties()

Gets a list of Properties.

Returns:

the Properties