Package io.openems.common.jsonrpc.request

Class QueryHistoricTimeseriesDataRequest

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

public class QueryHistoricTimeseriesDataRequest
extends JsonrpcRequest

Represents a JSON-RPC Request for 'queryHistoricTimeseriesData'.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "queryHistoricTimeseriesData",
   "params": {
     "fromDate": YYYY-MM-DD,
     "toDate": YYYY-MM-DD,
     "channels": ChannelAddress[],
     "timezone": String,
     "resolution"?: {
       "value": Number,
       "unit": ChronoUnit
     }
   }
 }
 

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
QueryHistoricTimeseriesDataRequest(ZonedDateTime fromDate, ZonedDateTime toDate, Optional<Resolution> resolution)

Method Summary

Modifier and Type	Method	Description
static QueryHistoricTimeseriesDataRequest	from(JsonrpcRequest r)	Create QueryHistoricTimeseriesDataRequest from a template JsonrpcRequest.
TreeSet<ChannelAddress>	getChannels()	Gets the ChannelAddresses.
ZonedDateTime	getFromDate()	Gets the From-Date.
com.google.gson.JsonObject	getParams()	Gets the params JsonObject of the JsonrpcRequest.
Optional<Resolution>	getResolution()	Gets the requested Resolution.
ZonedDateTime	getToDate()	Gets the To-Date.

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

QueryHistoricTimeseriesDataRequest

public QueryHistoricTimeseriesDataRequest(ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Optional<Resolution> resolution)
                                   throws OpenemsError.OpenemsNamedException

Throws:

OpenemsError.OpenemsNamedException

Method Details

from

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

Create QueryHistoricTimeseriesDataRequest from a template JsonrpcRequest.

Parameters:

r - the template JsonrpcRequest

Returns:

the QueryHistoricTimeseriesDataRequest

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

getFromDate

public ZonedDateTime getFromDate()

Gets the From-Date.

Returns:

From-Date

getToDate

public ZonedDateTime getToDate()

Gets the To-Date.

Returns:

To-Date

getChannels

public TreeSet<ChannelAddress> getChannels()

Gets the ChannelAddresses.

Returns:

Set of ChannelAddress

getResolution

public Optional<Resolution> getResolution()

Gets the requested Resolution.

Returns:

Resolution