Package io.openems.edge.meter.discovergy.jsonrpc

Class GetFieldNamesRequest

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.AbstractJsonrpcRequest

io.openems.common.jsonrpc.base.JsonrpcRequest

io.openems.edge.meter.discovergy.jsonrpc.GetFieldNamesRequest

public class GetFieldNamesRequest
extends JsonrpcRequest

Represents a JSON-RPC Request for 'getMeters'.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "getMeters",
   "params": {
     "meterId": String
   }
 }
 

Field Summary

Fields

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

Constructor	Description
GetFieldNamesRequest(String meterId)

Method Summary

Modifier and Type	Method	Description
static GetFieldNamesRequest	from(JsonrpcRequest r)	Create GetFieldNamesRequest from a template JsonrpcRequest.
String	getMeterId()	Gets the Meter-ID.
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

Constructor Details

GetFieldNamesRequest

public GetFieldNamesRequest(String meterId)

Method Details

from

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

Create GetFieldNamesRequest from a template JsonrpcRequest.

Parameters:

r - the template JsonrpcRequest

Returns:

the GetFieldNamesRequest

Throws:

OpenemsError.OpenemsNamedException - on parse error

getMeterId

public String getMeterId()

Gets the Meter-ID.

Returns:

Meter-ID

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