The Empathic Building measurements create API data provider. More...

Inheritance diagram for EmpathicBuildingDataProvider::EmpathicBuildingMeasurementsCreateDataProvider:

Public Member Methods
	constructor (*hash< auto > options)
	Creates the object from constructor options.

	constructor (RestClient::RestClient rest, *Logger::LoggerInterface logger)
	Creates the object from a REST connection.

*string	getDesc ()
	Returns the data provider description.

string	getName ()
	Returns the data provider name.

hash< DataProvider::DataProviderInfo >	getStaticInfoImpl ()
	Returns data provider static info.

Public Member Methods inherited from EmpathicBuildingDataProvider::EmpathicBuildingDataProviderBase
	constructor ()
	Creates the object.

	constructor (RestClient::RestClient rest, *Logger::LoggerInterface logger)
	Creates the object.

	setLogger (*LoggerInterface logger)
	Accepts a LoggerInterface object for logging (or clears it)

	updateConnectionObjects (object conn, object connobj)
	Update any connection used by the data provider.

Public Attributes
const	ProviderInfo = ...
	Provider info.

const	ProviderSummaryInfo = ...
	Provider summary info.

const	RequestType = new SoftListDataType("EmpathicBuildingMeasurementEventType", new EmpathicBuildingMeasurementsCreateRequestDataType())
	Request type.

const	ResponseType = AbstractDataProviderTypeMap."hash"
	Response type.

Public Attributes inherited from EmpathicBuildingDataProvider::EmpathicBuildingDataProviderBase
const	MaxIoRetries = 5
	Max retries.

const	RetrySet = ...
	IO errors for REST retries.

Private Member Methods
auto	doRequestImpl (auto req, *hash< auto > request_options)
	Makes a request and returns the response.

*DataProvider::AbstractDataProviderType	getRequestTypeImpl ()
	Returns the description of a successful request message, if any.

*DataProvider::AbstractDataProviderType	getResponseTypeImpl ()
	Returns the description of a response message, if this object represents a response message.

Private Member Methods inherited from EmpathicBuildingDataProvider::EmpathicBuildingDataProviderBase
hash< auto >	doRestCommand (string method, string path, auto body, reference< hash< auto > > info)
	Makes a REST call and returns the response.

bool	retry (hash< ExceptionInfo > ex, reference< int > retries)
	Returns True if the error indicates that the operation should be retried.

Additional Inherited Members
Static Public Member Methods inherited from EmpathicBuildingDataProvider::EmpathicBuildingDataProviderBase
static date	getTimestamp (int epoch_ms)
	Converts a Haltian ms epoch offset to a date/time value.

Private Attributes inherited from EmpathicBuildingDataProvider::EmpathicBuildingDataProviderBase
RestClient::RestClient	rest
	The REST client object for API calls.

Detailed Description

The Empathic Building measurements create API data provider.

This API allows the caller to create Empathic Building measurements

Member Function Documentation

auto EmpathicBuildingDataProvider::EmpathicBuildingMeasurementsCreateDataProvider::doRequestImpl	(	auto	req,
		*hash< auto >	request_options
	)

private

Makes a request and returns the response.

Parameters

req	the request to serialize and make according to the request type
request_options	the request options; will be processed by validateRequestOptions()

*DataProvider::AbstractDataProviderType EmpathicBuildingDataProvider::EmpathicBuildingMeasurementsCreateDataProvider::getRequestTypeImpl ( )

private

Returns the description of a successful request message, if any.

*DataProvider::AbstractDataProviderType EmpathicBuildingDataProvider::EmpathicBuildingMeasurementsCreateDataProvider::getResponseTypeImpl ( )

private

Returns the description of a response message, if this object represents a response message.