Package io.openems.common.jsonrpc.request

Class GetEdgeRequest

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

public class GetEdgeRequest
extends JsonrpcRequest

JSON-RPC Request for getting a edge.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "getEdge",
   "params": {
     "edgeId": string
   }
 }
 

Field Summary

Fields

Modifier and Type	Field	Description
final String	edgeId
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

Modifier	Constructor	Description
protected	GetEdgeRequest(JsonrpcRequest request, String edgeId)

Method Summary

Modifier and Type	Method	Description
static GetEdgeRequest	from(JsonrpcRequest request)	Creates a GetEdgeRequest from a JsonrpcRequest.
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

edgeId

public final String edgeId

Constructor Details

GetEdgeRequest

protected GetEdgeRequest(JsonrpcRequest request,
 String edgeId)

Method Details

from

public static GetEdgeRequest from(JsonrpcRequest request)
                           throws OpenemsError.OpenemsNamedException

Creates a GetEdgeRequest from a JsonrpcRequest.

Parameters:

request - the JsonrpcRequest

Returns:

the GetEdgeRequest

Throws:

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