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

Class ExecuteSystemUpdateRequest

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.ExecuteSystemUpdateRequest

public class ExecuteSystemUpdateRequest
extends JsonrpcRequest

Executes a System Update.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "executeSystemUpdate",
   "params": {
     "isDebug": boolean
   }
 }
 

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
ExecuteSystemUpdateRequest(boolean isDebug)

Method Summary

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

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

ExecuteSystemUpdateRequest

public ExecuteSystemUpdateRequest(boolean isDebug)

Method Details

from

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

Parses a generic JsonrpcRequest to a ExecuteSystemUpdateRequest.

Parameters:

r - the JsonrpcRequest

Returns:

the ExecuteSystemUpdateRequest

Throws:

OpenemsError.OpenemsNamedException - on 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

isDebug

public boolean isDebug()