Package io.openems.edge.core.host.jsonrpc

Class SystemUpdateRequest

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.AbstractJsonrpcRequest

io.openems.common.jsonrpc.base.JsonrpcRequest

io.openems.edge.core.host.jsonrpc.SystemUpdateRequest

public class SystemUpdateRequest
extends JsonrpcRequest

Represents a JSON-RPC Request to execute a system update.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "systemUpdate",
   "params": {}
 }
 

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

Method Summary

Modifier and Type	Method	Description
static SystemUpdateRequest	from(JsonrpcRequest r)	Parses a generic JsonrpcRequest to a SystemUpdateRequest.
com.google.gson.JsonObject	getParams()	Gets the params JsonObject of the JsonrpcRequest.

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

Method Details

from

public static SystemUpdateRequest from(JsonrpcRequest r)
                                throws OpenemsException

Parses a generic JsonrpcRequest to a SystemUpdateRequest.

Parameters:

r - the JsonrpcRequest

Returns:

the SystemUpdateRequest

Throws:

OpenemsError.OpenemsNamedException - on error

OpenemsException

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