HomeGuidesAPI ReferenceChangelog
Log In
API Reference

DataStore

defines a data store configuration for time-series storage.

Attributes

NameTypeDescription
data_store_iduuid.UUIDtechnical id of the data store.
namestrdisplay name of the data store.
bucketstrtime-series bucket name.
measurementstrmeasurement name within the bucket.
retention_secondsintretention period in seconds.
do_not_use_sensor_idboolif True, do not use sensor ID in storage path.

Methods

api_id()

return current object id on Web API format.

endpoint()

return endpoint name used to contact backend.

from_json()

load the object from a dict originating of a JSON format.

NameTypeDefaultDescription
objobject to load information from.

set_id()

specify the id_value neutrally

NameTypeDefaultDescription
id_value
return:

to_json()

transform current object into a dict that could be JSONIFY.

NameTypeDefaultDescription
targetstrNone
return: dumpable dict.