iottsbulk.models package¶

Submodules¶

iottsbulk.models.bulk_import_input module¶

IoT Time Series Bulk API

This API allows to bulk import IoT time series data based on files uploaded via IoT File Service. Data import for simulation assets (entities) is supported with up to nano second precision and for performance assets (entities) with up to milli second precision. A bulk import is modeled as asynchronous job whose status can be retrieved after creation. Successfully imported time series data can be retrieved using the read operation. # noqa: E501

class BulkImportInput(data=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 = {'data': 'data'}¶

attribute_types = {'data': 'list[Data]'}¶

data¶

Gets the data of this BulkImportInput.

Returns:	The data of this BulkImportInput.
Return type:	list[Data]

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

iottsbulk.models.create_import_job_request module¶

IoT Time Series Bulk API

This API allows to bulk import IoT time series data based on files uploaded via IoT File Service. Data import for simulation assets (entities) is supported with up to nano second precision and for performance assets (entities) with up to milli second precision. A bulk import is modeled as asynchronous job whose status can be retrieved after creation. Successfully imported time series data can be retrieved using the read operation. # noqa: E501

class CreateImportJobRequest(bulk_import_input=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 = {'bulk_import_input': 'bulkImportInput'}¶

attribute_types = {'bulk_import_input': 'BulkImportInput'}¶

bulk_import_input¶

Gets the bulk_import_input of this CreateImportJobRequest.

Returns:	The bulk_import_input of this CreateImportJobRequest.
Return type:	BulkImportInput

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

iottsbulk.models.data module¶

IoT Time Series Bulk API

This API allows to bulk import IoT time series data based on files uploaded via IoT File Service. Data import for simulation assets (entities) is supported with up to nano second precision and for performance assets (entities) with up to milli second precision. A bulk import is modeled as asynchronous job whose status can be retrieved after creation. Successfully imported time series data can be retrieved using the read operation. # noqa: E501

class Data(entity=None, property_set_name=None, timeseries_files=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 = {'entity': 'entity', 'property_set_name': 'propertySetName', 'timeseries_files': 'timeseriesFiles'}¶

attribute_types = {'entity': 'str', 'property_set_name': 'str', 'timeseries_files': 'list[FileInfo]'}¶

entity¶

Gets the entity of this Data. Unique ID of an asset (entity).

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

property_set_name¶

Gets the property_set_name of this Data. Unique name of a aspect (property set).

Returns:	The property_set_name of this Data.
Return type:	str

timeseries_files¶

Gets the timeseries_files of this Data. Information on files uploaded with IoT File Service, to be considered as sources for importing time series data. The time ranges defined by properties “from” and “to” for the provided files must not overlap.

Returns:	The timeseries_files of this Data.
Return type:	list[FileInfo]

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

iottsbulk.models.error module¶

IoT Time Series Bulk API

This API allows to bulk import IoT time series data based on files uploaded via IoT File Service. Data import for simulation assets (entities) is supported with up to nano second precision and for performance assets (entities) with up to milli second precision. A bulk import is modeled as asynchronous job whose status can be retrieved after creation. Successfully imported time series data can be retrieved using the read operation. # noqa: E501

class Error(timestamp=None, status=None, error=None, exception=None, message=None, path=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 = {'error': 'error', 'exception': 'exception', 'message': 'message', 'path': 'path', 'status': 'status', 'timestamp': 'timestamp'}¶

attribute_types = {'error': 'str', 'exception': 'str', 'message': 'str', 'path': 'str', 'status': 'int', 'timestamp': 'datetime'}¶

error¶

Gets the error of this Error.

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

exception¶

Gets the exception of this Error.

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

message¶

Gets the message of this Error.

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

path¶

Gets the path of this Error.

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

status¶

Gets the status of this Error.

Returns:	The status of this Error.
Return type:	int

timestamp¶

Gets the timestamp of this Error.

Returns:	The timestamp of this Error.
Return type:	datetime

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

iottsbulk.models.file_info module¶

IoT Time Series Bulk API

This API allows to bulk import IoT time series data based on files uploaded via IoT File Service. Data import for simulation assets (entities) is supported with up to nano second precision and for performance assets (entities) with up to milli second precision. A bulk import is modeled as asynchronous job whose status can be retrieved after creation. Successfully imported time series data can be retrieved using the read operation. # noqa: E501

class FileInfo(file_path=None, _from=None, to=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 FileInfo. Must match the time of the first time series record appearing in the file, in ISO date-time format. Is used for pre-validations on import job creation.

Returns:	The _from of this FileInfo.
Return type:	datetime

attribute_map = {'_from': 'from', 'file_path': 'filePath', 'to': 'to'}¶

attribute_types = {'_from': 'datetime', 'file_path': 'str', 'to': 'datetime'}¶

file_path¶

Gets the file_path of this FileInfo. Path of JSON text file containing time series data, uploaded with IoT File Service.

Returns:	The file_path of this FileInfo.
Return type:	str

to¶

Gets the to of this FileInfo. Must match the time of the last time series record in the file, in ISO date-time format. Is used for pre-validations on import job creation.

Returns:	The to of this FileInfo.
Return type:	datetime

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

iottsbulk.models.job_status module¶

IoT Time Series Bulk API

This API allows to bulk import IoT time series data based on files uploaded via IoT File Service. Data import for simulation assets (entities) is supported with up to nano second precision and for performance assets (entities) with up to milli second precision. A bulk import is modeled as asynchronous job whose status can be retrieved after creation. Successfully imported time series data can be retrieved using the read operation. # noqa: E501

class JobStatus(job_id=None, status=None, message=None, job_start_time=None, job_last_modified=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 = {'job_id': 'jobId', 'job_last_modified': 'jobLastModified', 'job_start_time': 'jobStartTime', 'message': 'message', 'status': 'status'}¶

attribute_types = {'job_id': 'str', 'job_last_modified': 'datetime', 'job_start_time': 'datetime', 'message': 'str', 'status': 'str'}¶

job_id¶

Gets the job_id of this JobStatus. Unique import job ID.

Returns:	The job_id of this JobStatus.
Return type:	str

job_last_modified¶

Gets the job_last_modified of this JobStatus. Job last modified time in ISO date format. The backend updates this time whenever the message changes.

Returns:	The job_last_modified of this JobStatus.
Return type:	datetime

job_start_time¶

Gets the job_start_time of this JobStatus. Start time of data import in ISO date format.

Returns:	The job_start_time of this JobStatus.
Return type:	datetime

message¶

Gets the message of this JobStatus. Contains an error message in case the job status equals FAILED. Possible error messages: - The input files are having data for more than one hour. - The input files are having duplicate data based on time interval. - The input files are having overlapping data based on time interval. - Input data is having invalid file format. - The input contains data for multiple combinations of asset (entity) and aspect (property set) names. - The input ‘from’ time and actual ‘from’ time of file does not match. - The input ‘to’ time and actual ‘to’ time of file does not match. - The input files contain variables that are not part of the aspect (property set). - The timestamp in input file is not formatted as per ISO time format. - The input property value in input file is not of valid type as per property type. - Error in bulk ingestion: for input file {0}, input time {1} is not acceptable. - Error in bulk ingestion: for input file {0}, invalid time {1} is given as input, up to milli-second time precision is allowed for performance asset (entity). - Error in bulk ingestion: given input File {0}, is an invalid JSON file.

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

status¶

Gets the status of this JobStatus. Status of bulk ingest job. - SUBMITTED: job has been created but import to time series store not yet started. - IN_PROGRESS: import of data has been started. Subsets of the data might already be available to be retrieved. - FAILED: time series import has failed. No data is available to be retrieved. - SUCCESS: time series data import has been successfully finished.

Returns:	The status of this JobStatus.
Return type:	str

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

iottsbulk.models.retrieve_import_job_request module¶

IoT Time Series Bulk API

This API allows to bulk import IoT time series data based on files uploaded via IoT File Service. Data import for simulation assets (entities) is supported with up to nano second precision and for performance assets (entities) with up to milli second precision. A bulk import is modeled as asynchronous job whose status can be retrieved after creation. Successfully imported time series data can be retrieved using the read operation. # noqa: E501

class RetrieveImportJobRequest(id=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 = {'id': 'id'}¶

attribute_types = {'id': 'str'}¶

id¶

Gets the id of this RetrieveImportJobRequest.

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

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

iottsbulk.models.retrieve_timeseries_request module¶

IoT Time Series Bulk API

This API allows to bulk import IoT time series data based on files uploaded via IoT File Service. Data import for simulation assets (entities) is supported with up to nano second precision and for performance assets (entities) with up to milli second precision. A bulk import is modeled as asynchronous job whose status can be retrieved after creation. Successfully imported time series data can be retrieved using the read operation. # noqa: E501

class RetrieveTimeseriesRequest(select=None, property_set_name=None, limit=None, _from=None, to=None, entity=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 RetrieveTimeseriesRequest.

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

attribute_map = {'_from': 'from', 'entity': 'entity', 'limit': 'limit', 'property_set_name': 'propertySetName', 'select': 'select', 'to': 'to'}¶

attribute_types = {'_from': 'str', 'entity': 'str', 'limit': 'int', 'property_set_name': 'str', 'select': 'str', 'to': 'str'}¶

entity¶

Gets the entity of this RetrieveTimeseriesRequest.

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

limit¶

Gets the limit of this RetrieveTimeseriesRequest.

Returns:	The limit of this RetrieveTimeseriesRequest.
Return type:	int

property_set_name¶

Gets the property_set_name of this RetrieveTimeseriesRequest.

Returns:	The property_set_name of this RetrieveTimeseriesRequest.
Return type:	str

select¶

Gets the select of this RetrieveTimeseriesRequest.

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

to¶

Gets the to of this RetrieveTimeseriesRequest.

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

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

iottsbulk.models.time_series module¶

IoT Time Series Bulk API

This API allows to bulk import IoT time series data based on files uploaded via IoT File Service. Data import for simulation assets (entities) is supported with up to nano second precision and for performance assets (entities) with up to milli second precision. A bulk import is modeled as asynchronous job whose status can be retrieved after creation. Successfully imported time series data can be retrieved using the read operation. # noqa: E501

class TimeSeries(records=None, next_record=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 = {'next_record': 'nextRecord', 'records': 'records'}¶

attribute_types = {'next_record': 'str', 'records': 'list[dict(str, object)]'}¶

next_record¶

Gets the next_record of this TimeSeries. nextRecord url returned when response is not complete in current response

Returns:	The next_record of this TimeSeries.
Return type:	str

records¶

Gets the records of this TimeSeries. Array of Timeseries records

Returns:	The records of this TimeSeries.
Return type:	list[dict(str, object)]

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

Module contents¶

IoT Time Series Bulk API

This API allows to bulk import IoT time series data based on files uploaded via IoT File Service. Data import for simulation assets (entities) is supported with up to nano second precision and for performance assets (entities) with up to milli second precision. A bulk import is modeled as asynchronous job whose status can be retrieved after creation. Successfully imported time series data can be retrieved using the read operation. # noqa: E501