tsaggregates.models package

Submodules

tsaggregates.models.aggregate module

IoT TS Aggregates API

The aggregate service enables querying aggregated time series data including * aggregates generated on the fly * aggregates pre-calculated during ingest Depending on, if entity is performance or simulation entity, different aggregation intervals are supported. ### Performance Entity Pre-calculated aggregates are available in the following intervals * 2 minute * 1 hour * 1 day Intervals smaller than 2 minutes are also available and generated on the fly. ### Simulation Entity Pre-calculated aggregates are available in the following intervals * 1 millisecond * 10 millisecond * 1 second On the fly aggregation is not supported for simulation entities. Note: There might be time series data ingested in the past for which pre-calculated aggregates have not been computed. In that case for simulation entities, no aggregated data is returned. # noqa: E501

class Aggregate(countgood=None, countuncertain=None, countbad=None, sum=None, average=None, mintime=None, minvalue=None, maxtime=None, maxvalue=None, firsttime=None, firstvalue=None, lasttime=None, lastvalue=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'average': 'average', 'countbad': 'countbad', 'countgood': 'countgood', 'countuncertain': 'countuncertain', 'firsttime': 'firsttime', 'firstvalue': 'firstvalue', 'lasttime': 'lasttime', 'lastvalue': 'lastvalue', 'maxtime': 'maxtime', 'maxvalue': 'maxvalue', 'mintime': 'mintime', 'minvalue': 'minvalue', 'sum': 'sum'}

attribute_types = {'average': 'float', 'countbad': 'int', 'countgood': 'int', 'countuncertain': 'int', 'firsttime': 'datetime', 'firstvalue': 'float', 'lasttime': 'datetime', 'lastvalue': 'float', 'maxtime': 'datetime', 'maxvalue': 'float', 'mintime': 'datetime', 'minvalue': 'float', 'sum': 'float'}

average

Gets the average of this Aggregate. Average of the values within the interval.

Returns:The average of this Aggregate. Return type:float

countbad

Gets the countbad of this Aggregate. Number of bad records in the aggregated interval.

Returns:The countbad of this Aggregate. Return type:int

countgood

Gets the countgood of this Aggregate. Number of good records in the aggregated interval.

Returns:The countgood of this Aggregate. Return type:int

countuncertain

Gets the countuncertain of this Aggregate. Number of uncertain records in the aggregated interval.

Returns:The countuncertain of this Aggregate. Return type:int

firsttime

Gets the firsttime of this Aggregate. Timestamp of the first value within the interval.

Returns:The firsttime of this Aggregate. Return type:datetime

firstvalue

Gets the firstvalue of this Aggregate. First value within the interval.

Returns:The firstvalue of this Aggregate. Return type:float

lasttime

Gets the lasttime of this Aggregate. Timestamp of the last measurement within the interval.

Returns:The lasttime of this Aggregate. Return type:datetime

lastvalue

Gets the lastvalue of this Aggregate. Last value within the interval.

Returns:The lastvalue of this Aggregate. Return type:float

maxtime

Gets the maxtime of this Aggregate. Timestamp of the maximum value within the interval.

Returns:The maxtime of this Aggregate. Return type:datetime

maxvalue

Gets the maxvalue of this Aggregate. Maximum value within the interval.

Returns:The maxvalue of this Aggregate. Return type:float

mintime

Gets the mintime of this Aggregate. Timestamp of the minimum value within the interval.

Returns:The mintime of this Aggregate. Return type:datetime

minvalue

Gets the minvalue of this Aggregate. Minimum value within the interval.

Returns:The minvalue of this Aggregate. Return type:float

sum

Gets the sum of this Aggregate. Sum of the values within the interval.

Returns:The sum of this Aggregate. Return type:float

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

tsaggregates.models.aggregates module

IoT TS Aggregates API

The aggregate service enables querying aggregated time series data including * aggregates generated on the fly * aggregates pre-calculated during ingest Depending on, if entity is performance or simulation entity, different aggregation intervals are supported. ### Performance Entity Pre-calculated aggregates are available in the following intervals * 2 minute * 1 hour * 1 day Intervals smaller than 2 minutes are also available and generated on the fly. ### Simulation Entity Pre-calculated aggregates are available in the following intervals * 1 millisecond * 10 millisecond * 1 second On the fly aggregation is not supported for simulation entities. Note: There might be time series data ingested in the past for which pre-calculated aggregates have not been computed. In that case for simulation entities, no aggregated data is returned. # noqa: E501

class Aggregates(starttime=None, endtime=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'endtime': 'endtime', 'starttime': 'starttime'}

attribute_types = {'endtime': 'datetime', 'starttime': 'datetime'}

endtime

Gets the endtime of this Aggregates. end time of the interval (inclusive)

Returns:The endtime of this Aggregates. Return type:datetime

starttime

Gets the starttime of this Aggregates. start time of the interval (exclusive)

Returns:The starttime of this Aggregates. Return type:datetime

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

tsaggregates.models.badrequest module

IoT TS Aggregates API

The aggregate service enables querying aggregated time series data including * aggregates generated on the fly * aggregates pre-calculated during ingest Depending on, if entity is performance or simulation entity, different aggregation intervals are supported. ### Performance Entity Pre-calculated aggregates are available in the following intervals * 2 minute * 1 hour * 1 day Intervals smaller than 2 minutes are also available and generated on the fly. ### Simulation Entity Pre-calculated aggregates are available in the following intervals * 1 millisecond * 10 millisecond * 1 second On the fly aggregation is not supported for simulation entities. Note: There might be time series data ingested in the past for which pre-calculated aggregates have not been computed. In that case for simulation entities, no aggregated data is returned. # noqa: E501

class Badrequest(id=None, message=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'id': 'id', 'message': 'message'}

attribute_types = {'id': 'str', 'message': 'str'}

id

Gets the id of this Badrequest.

Returns:The id of this Badrequest. Return type:str

message

Gets the message of this Badrequest.

Returns:The message of this Badrequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

tsaggregates.models.error module

IoT TS Aggregates API

The aggregate service enables querying aggregated time series data including * aggregates generated on the fly * aggregates pre-calculated during ingest Depending on, if entity is performance or simulation entity, different aggregation intervals are supported. ### Performance Entity Pre-calculated aggregates are available in the following intervals * 2 minute * 1 hour * 1 day Intervals smaller than 2 minutes are also available and generated on the fly. ### Simulation Entity Pre-calculated aggregates are available in the following intervals * 1 millisecond * 10 millisecond * 1 second On the fly aggregation is not supported for simulation entities. Note: There might be time series data ingested in the past for which pre-calculated aggregates have not been computed. In that case for simulation entities, no aggregated data is returned. # noqa: E501

class Error(id=None, message=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'id': 'id', 'message': 'message'}

attribute_types = {'id': 'str', 'message': 'str'}

id

Gets the id of this Error.

Returns:The id of this Error. Return type:str

message

Gets the message of this Error.

Returns:The message of this Error. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

tsaggregates.models.get_aggregate_timeseries_request module

IoT TS Aggregates API

The aggregate service enables querying aggregated time series data including * aggregates generated on the fly * aggregates pre-calculated during ingest Depending on, if entity is performance or simulation entity, different aggregation intervals are supported. ### Performance Entity Pre-calculated aggregates are available in the following intervals * 2 minute * 1 hour * 1 day Intervals smaller than 2 minutes are also available and generated on the fly. ### Simulation Entity Pre-calculated aggregates are available in the following intervals * 1 millisecond * 10 millisecond * 1 second On the fly aggregation is not supported for simulation entities. Note: There might be time series data ingested in the past for which pre-calculated aggregates have not been computed. In that case for simulation entities, no aggregated data is returned. # noqa: E501

class GetAggregateTimeseriesRequest(select=None, propertyset=None, interval_unit=None, _from=None, to=None, entity=None, interval_value=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

_from

Gets the _from of this GetAggregateTimeseriesRequest.

Returns:The _from of this GetAggregateTimeseriesRequest. Return type:str

attribute_map = {'_from': 'from', 'entity': 'entity', 'interval_unit': 'intervalUnit', 'interval_value': 'intervalValue', 'propertyset': 'propertyset', 'select': 'select', 'to': 'to'}

attribute_types = {'_from': 'str', 'entity': 'str', 'interval_unit': 'str', 'interval_value': 'float', 'propertyset': 'str', 'select': 'str', 'to': 'str'}

entity

Gets the entity of this GetAggregateTimeseriesRequest.

Returns:The entity of this GetAggregateTimeseriesRequest. Return type:str

interval_unit

Gets the interval_unit of this GetAggregateTimeseriesRequest.

Returns:The interval_unit of this GetAggregateTimeseriesRequest. Return type:str

interval_value

Gets the interval_value of this GetAggregateTimeseriesRequest.

Returns:The interval_value of this GetAggregateTimeseriesRequest. Return type:float

propertyset

Gets the propertyset of this GetAggregateTimeseriesRequest.

Returns:The propertyset of this GetAggregateTimeseriesRequest. Return type:str

select

Gets the select of this GetAggregateTimeseriesRequest.

Returns:The select of this GetAggregateTimeseriesRequest. Return type:str

to

Gets the to of this GetAggregateTimeseriesRequest.

Returns:The to of this GetAggregateTimeseriesRequest. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

tsaggregates.models.notfound module

IoT TS Aggregates API

The aggregate service enables querying aggregated time series data including * aggregates generated on the fly * aggregates pre-calculated during ingest Depending on, if entity is performance or simulation entity, different aggregation intervals are supported. ### Performance Entity Pre-calculated aggregates are available in the following intervals * 2 minute * 1 hour * 1 day Intervals smaller than 2 minutes are also available and generated on the fly. ### Simulation Entity Pre-calculated aggregates are available in the following intervals * 1 millisecond * 10 millisecond * 1 second On the fly aggregation is not supported for simulation entities. Note: There might be time series data ingested in the past for which pre-calculated aggregates have not been computed. In that case for simulation entities, no aggregated data is returned. # noqa: E501

class Notfound(id=None, message=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'id': 'id', 'message': 'message'}

attribute_types = {'id': 'str', 'message': 'str'}

id

Gets the id of this Notfound.

Returns:The id of this Notfound. Return type:str

message

Gets the message of this Notfound.

Returns:The message of this Notfound. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

tsaggregates.models.unauthorized module

IoT TS Aggregates API

The aggregate service enables querying aggregated time series data including * aggregates generated on the fly * aggregates pre-calculated during ingest Depending on, if entity is performance or simulation entity, different aggregation intervals are supported. ### Performance Entity Pre-calculated aggregates are available in the following intervals * 2 minute * 1 hour * 1 day Intervals smaller than 2 minutes are also available and generated on the fly. ### Simulation Entity Pre-calculated aggregates are available in the following intervals * 1 millisecond * 10 millisecond * 1 second On the fly aggregation is not supported for simulation entities. Note: There might be time series data ingested in the past for which pre-calculated aggregates have not been computed. In that case for simulation entities, no aggregated data is returned. # noqa: E501

class Unauthorized(id=None, message=None)

Bases: object

Attributes:

attribute_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {'id': 'id', 'message': 'message'}

attribute_types = {'id': 'str', 'message': 'str'}

id

Gets the id of this Unauthorized.

Returns:The id of this Unauthorized. Return type:str

message

Gets the message of this Unauthorized.

Returns:The message of this Unauthorized. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Module contents

IoT TS Aggregates API

The aggregate service enables querying aggregated time series data including * aggregates generated on the fly * aggregates pre-calculated during ingest Depending on, if entity is performance or simulation entity, different aggregation intervals are supported. ### Performance Entity Pre-calculated aggregates are available in the following intervals * 2 minute * 1 hour * 1 day Intervals smaller than 2 minutes are also available and generated on the fly. ### Simulation Entity Pre-calculated aggregates are available in the following intervals * 1 millisecond * 10 millisecond * 1 second On the fly aggregation is not supported for simulation entities. Note: There might be time series data ingested in the past for which pre-calculated aggregates have not been computed. In that case for simulation entities, no aggregated data is returned. # noqa: E501