Package io.openems.edge.core.appmanager.jsonrpc

Class UpdateAppInstance

java.lang.Object

io.openems.edge.core.appmanager.jsonrpc.UpdateAppInstance

All Implemented Interfaces:

EndpointRequestType<UpdateAppInstance.Request,UpdateAppInstance.Response>

public class UpdateAppInstance
extends Object
implements EndpointRequestType<UpdateAppInstance.Request,UpdateAppInstance.Response>

Updates an OpenemsAppInstance..

Request:

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "updateAppInstance",
   "params": {
     "instanceId": string (uuid),
     "properties": {}
   }
 }
 

Response:

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "result": {
     "instance": OpenemsAppInstance.toJsonObject()
     "warnings": string[]
   }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	UpdateAppInstance.Request
static final record	UpdateAppInstance.Response

Constructor Summary

Constructors

Constructor	Description
UpdateAppInstance()

Method Summary

Modifier and Type	Method	Description
String	getMethod()	Gets the name of the request method.
JsonSerializer<UpdateAppInstance.Request>	getRequestSerializer()	Gets the JsonSerializer for the request.
JsonSerializer<UpdateAppInstance.Response>	getResponseSerializer()	Gets the JsonSerializer for the response.

Methods inherited from class java.lang.Object

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

Constructor Details

UpdateAppInstance

public UpdateAppInstance()

Method Details

getMethod

public String getMethod()

Description copied from interface: EndpointRequestType

Gets the name of the request method.

Specified by:

getMethod in interface EndpointRequestType<UpdateAppInstance.Request,UpdateAppInstance.Response>

Returns:

the method name

getRequestSerializer

public JsonSerializer<UpdateAppInstance.Request> getRequestSerializer()

Description copied from interface: EndpointRequestType

Gets the JsonSerializer for the request. Used to convert the received json into a java object.

Specified by:

getRequestSerializer in interface EndpointRequestType<UpdateAppInstance.Request,UpdateAppInstance.Response>

Returns:

the request JsonSerializer

getResponseSerializer

public JsonSerializer<UpdateAppInstance.Response> getResponseSerializer()

Description copied from interface: EndpointRequestType

Gets the JsonSerializer for the response. Used to convert the response java object into a json string.

Specified by:

getResponseSerializer in interface EndpointRequestType<UpdateAppInstance.Request,UpdateAppInstance.Response>

Returns:

the response JsonSerializer