iottsaggregates.models package¶

Submodules¶

iottsaggregates.models.aggregates module¶

IoT TS Aggregates API

The aggregate service enables querying aggregated time series data for performance assets based on pre-calculated aggregate values. Precalculated aggregates are available in the following aggregate intervals * 2 minute * 1 hour * 1 day ## Generic Errors The following generic error codes (with status codes) can occur at the operations of this API. Generic error codes are prefixed with ‘mdsp.core.generic.’. - unauthorized (401) - forbidden (403) - tooManyRequests (429) - internalServerError (500) # noqa: E501

class Aggregates(aggregates=None)[source]¶

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.

aggregates¶

Gets the aggregates of this Aggregates.

Returns:	The aggregates of this Aggregates.
Return type:	list[AggregatesAggregates]

attribute_map = {'aggregates': 'aggregates'}¶

attribute_types = {'aggregates': 'list[AggregatesAggregates]'}¶

to_dict()[source]¶

Returns the model properties as a dict

to_str()[source]¶

Returns the string representation of the model

iottsaggregates.models.aggregates_aggregates module¶

IoT TS Aggregates API

The aggregate service enables querying aggregated time series data for performance assets based on pre-calculated aggregate values. Precalculated aggregates are available in the following aggregate intervals * 2 minute * 1 hour * 1 day ## Generic Errors The following generic error codes (with status codes) can occur at the operations of this API. Generic error codes are prefixed with ‘mdsp.core.generic.’. - unauthorized (401) - forbidden (403) - tooManyRequests (429) - internalServerError (500) # noqa: E501

class AggregatesAggregates(starttime=None, endtime=None, property1=None, property2=None)[source]¶

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', 'property1': 'property1', 'property2': 'property2', 'starttime': 'starttime'}¶

attribute_types = {'endtime': 'datetime', 'property1': 'Variable', 'property2': 'Variable', 'starttime': 'datetime'}¶

endtime¶

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

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

property1¶

Gets the property1 of this AggregatesAggregates.

Returns:	The property1 of this AggregatesAggregates.
Return type:	Variable

property2¶

Gets the property2 of this AggregatesAggregates.

Returns:	The property2 of this AggregatesAggregates.
Return type:	Variable

starttime¶

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

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

to_dict()[source]¶

Returns the model properties as a dict

to_str()[source]¶

Returns the string representation of the model

iottsaggregates.models.errors module¶

IoT TS Aggregates API

The aggregate service enables querying aggregated time series data for performance assets based on pre-calculated aggregate values. Precalculated aggregates are available in the following aggregate intervals * 2 minute * 1 hour * 1 day ## Generic Errors The following generic error codes (with status codes) can occur at the operations of this API. Generic error codes are prefixed with ‘mdsp.core.generic.’. - unauthorized (401) - forbidden (403) - tooManyRequests (429) - internalServerError (500) # noqa: E501

class Errors(errors=None)[source]¶

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 = {'errors': 'errors'}¶

attribute_types = {'errors': 'list[ErrorsErrors]'}¶

errors¶

Gets the errors of this Errors.

Returns:	The errors of this Errors.
Return type:	list[ErrorsErrors]

to_dict()[source]¶

Returns the model properties as a dict

to_str()[source]¶

Returns the string representation of the model

iottsaggregates.models.errors_errors module¶

IoT TS Aggregates API

The aggregate service enables querying aggregated time series data for performance assets based on pre-calculated aggregate values. Precalculated aggregates are available in the following aggregate intervals * 2 minute * 1 hour * 1 day ## Generic Errors The following generic error codes (with status codes) can occur at the operations of this API. Generic error codes are prefixed with ‘mdsp.core.generic.’. - unauthorized (401) - forbidden (403) - tooManyRequests (429) - internalServerError (500) # noqa: E501

class ErrorsErrors(code=None, logref=None, message=None, message_parameters=None)[source]¶

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 = {'code': 'code', 'logref': 'logref', 'message': 'message', 'message_parameters': 'messageParameters'}¶

attribute_types = {'code': 'str', 'logref': 'str', 'message': 'str', 'message_parameters': 'list[ErrorsMessageParameters]'}¶

code¶

Gets the code of this ErrorsErrors.

Returns:	The code of this ErrorsErrors.
Return type:	str

logref¶

Gets the logref of this ErrorsErrors.

Returns:	The logref of this ErrorsErrors.
Return type:	str

message¶

Gets the message of this ErrorsErrors.

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

message_parameters¶

Gets the message_parameters of this ErrorsErrors.

Returns:	The message_parameters of this ErrorsErrors.
Return type:	list[ErrorsMessageParameters]

to_dict()[source]¶

Returns the model properties as a dict

to_str()[source]¶

Returns the string representation of the model

iottsaggregates.models.errors_message_parameters module¶

IoT TS Aggregates API

The aggregate service enables querying aggregated time series data for performance assets based on pre-calculated aggregate values. Precalculated aggregates are available in the following aggregate intervals * 2 minute * 1 hour * 1 day ## Generic Errors The following generic error codes (with status codes) can occur at the operations of this API. Generic error codes are prefixed with ‘mdsp.core.generic.’. - unauthorized (401) - forbidden (403) - tooManyRequests (429) - internalServerError (500) # noqa: E501

class ErrorsMessageParameters(name=None, value=None)[source]¶

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 = {'name': 'name', 'value': 'value'}¶

attribute_types = {'name': 'str', 'value': 'str'}¶

name¶

Gets the name of this ErrorsMessageParameters.

Returns:	The name of this ErrorsMessageParameters.
Return type:	str

to_dict()[source]¶

Returns the model properties as a dict

to_str()[source]¶

Returns the string representation of the model

value¶

Gets the value of this ErrorsMessageParameters.

Returns:	The value of this ErrorsMessageParameters.
Return type:	str

iottsaggregates.models.retrieve_aggregates_request module¶

IoT TS Aggregates API

The aggregate service enables querying aggregated time series data for performance assets based on pre-calculated aggregate values. Precalculated aggregates are available in the following aggregate intervals * 2 minute * 1 hour * 1 day ## Generic Errors The following generic error codes (with status codes) can occur at the operations of this API. Generic error codes are prefixed with ‘mdsp.core.generic.’. - unauthorized (401) - forbidden (403) - tooManyRequests (429) - internalServerError (500) # noqa: E501

class RetrieveAggregatesRequest(aspect_name=None, select=None, asset_id=None, interval_unit=None, count=None, _from=None, to=None, interval_value=None)[source]¶

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

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

aspect_name¶

Gets the aspect_name of this RetrieveAggregatesRequest.

Returns:	The aspect_name of this RetrieveAggregatesRequest.
Return type:	str

asset_id¶

Gets the asset_id of this RetrieveAggregatesRequest.

Returns:	The asset_id of this RetrieveAggregatesRequest.
Return type:	str

attribute_map = {'_from': 'from', 'aspect_name': 'aspectName', 'asset_id': 'assetId', 'count': 'count', 'interval_unit': 'intervalUnit', 'interval_value': 'intervalValue', 'select': 'select', 'to': 'to'}¶

attribute_types = {'_from': 'str', 'aspect_name': 'str', 'asset_id': 'str', 'count': 'str', 'interval_unit': 'str', 'interval_value': 'float', 'select': 'str', 'to': 'str'}¶

count¶

Gets the count of this RetrieveAggregatesRequest.

Returns:	The count of this RetrieveAggregatesRequest.
Return type:	str

interval_unit¶

Gets the interval_unit of this RetrieveAggregatesRequest.

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

interval_value¶

Gets the interval_value of this RetrieveAggregatesRequest.

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

select¶

Gets the select of this RetrieveAggregatesRequest.

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

to¶

Gets the to of this RetrieveAggregatesRequest.

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

to_dict()[source]¶

Returns the model properties as a dict

to_str()[source]¶

Returns the string representation of the model

iottsaggregates.models.variable module¶

IoT TS Aggregates API

The aggregate service enables querying aggregated time series data for performance assets based on pre-calculated aggregate values. Precalculated aggregates are available in the following aggregate intervals * 2 minute * 1 hour * 1 day ## Generic Errors The following generic error codes (with status codes) can occur at the operations of this API. Generic error codes are prefixed with ‘mdsp.core.generic.’. - unauthorized (401) - forbidden (403) - tooManyRequests (429) - internalServerError (500) # noqa: E501

class Variable(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, sd=None)[source]¶

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', 'sd': 'sd', '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', 'sd': 'float', 'sum': 'float'}¶

average¶

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

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

countbad¶

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

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

countgood¶

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

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

countuncertain¶

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

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

firsttime¶

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

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

firstvalue¶

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

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

lasttime¶

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

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

lastvalue¶

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

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

maxtime¶

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

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

maxvalue¶

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

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

mintime¶

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

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

minvalue¶

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

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

sd¶

Gets the sd of this Variable. Standard deviation of the values within the interval. It will return null, if number goes beyond Double range during calculation of Standard Deviation.

Returns:	The sd of this Variable.
Return type:	float

sum¶

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

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

to_dict()[source]¶

Returns the model properties as a dict

to_str()[source]¶

Returns the string representation of the model

Module contents¶

IoT TS Aggregates API

The aggregate service enables querying aggregated time series data for performance assets based on pre-calculated aggregate values. Precalculated aggregates are available in the following aggregate intervals * 2 minute * 1 hour * 1 day ## Generic Errors The following generic error codes (with status codes) can occur at the operations of this API. Generic error codes are prefixed with ‘mdsp.core.generic.’. - unauthorized (401) - forbidden (403) - tooManyRequests (429) - internalServerError (500) # noqa: E501