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

Class ExecuteSystemRestartRequest

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

public class ExecuteSystemRestartRequest
extends JsonrpcRequest

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

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "executeSystemRestart",
   "params": {
        "type": "SOFT" | "HARD"
   }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ExecuteSystemRestartRequest.Type

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METHOD
final ExecuteSystemRestartRequest.Type	type

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
ExecuteSystemRestartRequest(ExecuteSystemRestartRequest.Type type)
ExecuteSystemRestartRequest(UUID id, ExecuteSystemRestartRequest.Type type)

Method Summary

Modifier and Type	Method	Description
static ExecuteSystemRestartRequest	from(JsonrpcRequest r)	Parses a generic JsonrpcRequest to a ExecuteSystemRestartRequest.
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

type

public final ExecuteSystemRestartRequest.Type type

Constructor Details

ExecuteSystemRestartRequest

public ExecuteSystemRestartRequest(ExecuteSystemRestartRequest.Type type)

ExecuteSystemRestartRequest

public ExecuteSystemRestartRequest(UUID id,
 ExecuteSystemRestartRequest.Type type)

Method Details

from

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

Parses a generic JsonrpcRequest to a ExecuteSystemRestartRequest.

Parameters:

r - the JsonrpcRequest

Returns:

the ExecuteSystemRestartRequest

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