Package io.openems.common.jsonrpc.request

Class AddAppInstanceRequest

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

public class AddAppInstanceRequest
extends JsonrpcRequest

Adds an OpenemsAppInstance. This is used by Ui to install a app on the edge.

Request:

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "addAppInstance",
   "params": {
     "appId": string,
     "alias": string,
     "key": string,
     "properties": {}
   }
 }
 

Field Summary

Fields

Modifier and Type	Field	Description
final String	alias
final String	appId
final String	key
static final String	METHOD
final com.google.gson.JsonObject	properties

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
AddAppInstanceRequest(String appId, String key, String alias, com.google.gson.JsonObject properties)

Method Summary

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

key

public final String key

appId

public final String appId

alias

public final String alias

properties

public final com.google.gson.JsonObject properties

Constructor Details

AddAppInstanceRequest

public AddAppInstanceRequest(String appId,
 String key,
 String alias,
 com.google.gson.JsonObject properties)

Method Details

from

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

Parses a generic JsonrpcRequest to a AddAppInstance.

Parameters:

r - the JsonrpcRequest

Returns:

the AddAppInstance Request

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