com.siemens.mindsphere.sdk.iotbulk.apiclient

Class BulkImportOperationsClient

Object

MindsphereAPIClient

BulkImportOperationsClient

public class BulkImportOperationsClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BulkImportOperationsClient.ClientBuilder

Nested classes/interfaces inherited from class MindsphereAPIClient

MindsphereAPIClient.Builder<T extends MindsphereAPIClient.Builder<T>>

Field Summary

Fields inherited from class MindsphereAPIClient

credentials, restClientConfig, restTemplate

Constructor Summary

Constructors

Constructor and Description
BulkImportOperationsClient(BulkImportOperationsClient.ClientBuilder builder)

Method Summary

Modifier and Type	Method and Description
static BulkImportOperationsClient.ClientBuilder	builder()
JobStatus	createImportJob(CreateImportJobRequest requestObject) Create bulk import job for importing time series data Creates an import job resource to asynchronously import IoT time series data from files uploaded through IoT File Service.
JobStatus	retrieveImportJob(RetrieveImportJobRequest requestObject) Retrieve status of bulk import job

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BulkImportOperationsClient

public BulkImportOperationsClient(BulkImportOperationsClient.ClientBuilder builder)

Method Detail

builder

public static BulkImportOperationsClient.ClientBuilder builder()

createImportJob

public JobStatus createImportJob(CreateImportJobRequest requestObject)
                          throws MindsphereException

Create bulk import job for importing time series data Creates an import job resource to asynchronously import IoT time series data from files uploaded through IoT File Service. After successful creation of an import job, the provided file contents are validated and imported in the background. The status of a job can be retrieved using the returned job ID. Note that in case of validation errors occuring during or after job creation, no time series data is imported from any of the provided files. ### Restrictions: ### Currently only one asset-aspect (entity-property set) combination can be specified as target of the import. Data for performance assets (entities) must be older than 30 minutes in order to be imported, while for simulation assets (entities) no restriction on minimum age exists. In case of simulation assets (entities), all data must be within the same hour. In case of performance assets (entities), all data must be within the same day. The overall size of the files used to import data for one asset-aspect (entity-property set) combination is limited: - For simulation assets (entities), a maximum of 350 MB per hour is allowed - For performance assets (entities), a maximum of 1 GB per day is allowed Note that hour and day intervals are fixed with respect to UTC time hours and days. A maximum of 100 files can be specified per request.

202 - bulk timeseries job triggered.

400 - The request will return HTTP 400 (BAD REQUEST) for the subsequent cases: - Unable to find the tenant. - Unable to find the asset (entity). - Unable to find the aspect (property set). - Unable to find the asset type (entity type). - The total file size for single / multiple jobs submitted for same hour interval, specific simulation asset (entity) and aspect (property set) exceeds 350 MB. - The total file size for single / multiple jobs submitted for same day interval, specific performance asset (entity) and aspect (property set) exceeds 1 GB. - The input consists of data for multiple combination of asset (entity) and aspect (property set) name. - Error in bulk ingestion: for input file {0}, data should be older than {1} minutes in case of performance asset (entity).

0 - Other error with any status code and response body format.

Parameters:

requestObject - - Object of type CreateImportJobRequest {Parameters are bulkImportInput*}

Returns:

JobStatus

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

retrieveImportJob

public JobStatus retrieveImportJob(RetrieveImportJobRequest requestObject)
                            throws MindsphereException

Retrieve status of bulk import job

200 - Ok

404 - The request will return HTTP 400 (BAD REQUEST) in cases you can find below. - The input job id does not exists.

0 - Other error with any status code and response body format.

Parameters:

requestObject - - Object of type RetrieveImportJobRequest {Parameters are id*}

Returns:

JobStatus

Throws:

MindsphereException - if an error occurs while attempting to invoke the API