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

Class GetSystemUpdateStateResponse

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.JsonrpcResponse

io.openems.common.jsonrpc.base.JsonrpcResponseSuccess

io.openems.edge.core.host.jsonrpc.GetSystemUpdateStateResponse

public class GetSystemUpdateStateResponse
extends JsonrpcResponseSuccess

JSON-RPC Response to GetSystemUpdateStateRequest.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "result": {
     // State is unknown (e.g. internet connection limited by firewall)
     "unknown"?: {
     }
     // Latest version is already installed
     "updated"?: {
       "version": "XXXX"
     }
     // Update is available
     "available"?: {
       "currentVersion": "XXXX",
       "latestVersion": "XXXX"
     },
     // Update is currently running
     "running"?: {
       "percentCompleted": number,
       "logs": string[]
     }
   }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetSystemUpdateStateResponse.UpdateState

Field Summary

Fields inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage

JSONRPC_VERSION

Method Summary

Modifier and Type	Method	Description
static GetSystemUpdateStateResponse	from(UUID id, String currentVersion, String latestVersion)	Builds a GetSystemUpdateStateResponse for GetSystemUpdateStateResponse.Unknown, GetSystemUpdateStateResponse.Updated or GetSystemUpdateStateResponse.Available state.
com.google.gson.JsonObject	getResult()	Gets the result of this JsonrpcResponseSuccess.
static GetSystemUpdateStateResponse	isRunning(UUID id, GetSystemUpdateStateResponse.UpdateState updateState)	Builds a GetSystemUpdateStateResponse for GetSystemUpdateStateResponse.Running state.

Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcResponseSuccess

from, toJsonObject

Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcResponse

from, getId

Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage

toString

Methods inherited from class java.lang.Object

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

Method Details

isRunning

public static GetSystemUpdateStateResponse isRunning(UUID id,
 GetSystemUpdateStateResponse.UpdateState updateState)

Builds a GetSystemUpdateStateResponse for GetSystemUpdateStateResponse.Running state.

Parameters:

id - the request ID

updateState - the GetSystemUpdateStateResponse.UpdateState

Returns:

the GetSystemUpdateStateResponse

from

public static GetSystemUpdateStateResponse from(UUID id,
 String currentVersion,
 String latestVersion)

Builds a GetSystemUpdateStateResponse for GetSystemUpdateStateResponse.Unknown, GetSystemUpdateStateResponse.Updated or GetSystemUpdateStateResponse.Available state.

Parameters:

id - the request ID

currentVersion - the current version

latestVersion - the latest version

Returns:

the GetSystemUpdateStateResponse

getResult

public com.google.gson.JsonObject getResult()

Description copied from class: JsonrpcResponseSuccess

Gets the result of this JsonrpcResponseSuccess.

Specified by:

getResult in class JsonrpcResponseSuccess

Returns:

a JsonObject with the 'result' property of the response