com.siemens.mindsphere.sdk.integrateddatalake.apiclient

Class TimeSeriesBulkImportClient

Object

MindsphereAPIClient

TimeSeriesBulkImportClient

public class TimeSeriesBulkImportClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimeSeriesBulkImportClient.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
TimeSeriesBulkImportClient(TimeSeriesBulkImportClient.ClientBuilder builder)

Method Summary

Modifier and Type	Method and Description
static TimeSeriesBulkImportClient.ClientBuilder	builder()
ImportJobResponse	createTimeSeriesImportJob(CreateTimeSeriesImportJobRequest requestObject) Creates a bulk import job of time series data into data lake.
void	deleteTimeSeriesImportJob(DeleteTimeSeriesImportJobRequest requestObject) Delete time series bulk import job by id.
ImportJobListResource	queryTimeSeriesImportJobs(QueryTimeSeriesImportJobsRequest requestObject) Query all time series bulk import jobs.
ImportJobResponse	retrieveTimeSeriesImportJob(RetrieveTimeSeriesImportJobRequest requestObject) Retrieve status of time series bulk import job.
ImportJobDetails	retrieveTimeSeriesImportJobDetails(RetrieveTimeSeriesImportJobDetailsRequest requestObject) Retreive details of a time series bulk import job.

Methods inherited from class Object

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

Constructor Detail

TimeSeriesBulkImportClient

public TimeSeriesBulkImportClient(TimeSeriesBulkImportClient.ClientBuilder builder)

Method Detail

builder

public static TimeSeriesBulkImportClient.ClientBuilder builder()

createTimeSeriesImportJob

public ImportJobResponse createTimeSeriesImportJob(CreateTimeSeriesImportJobRequest requestObject)
                                            throws MindsphereException

Creates a bulk import job of time series data into data lake. Creates an asynchronous job to bulk import time series data into data lake. The import takes into account time series data from the provided aspects associated to the provided assets, in the given time range.

202 - Import job accepted.

400 - Bad request. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>destinationPathLengthError</td> <td>Destination path, which is, the default path {defaultpath} and input path must be no longer than 1024 characters.</td> </tr> <tr> <td>destinationError</td> <td>Destination must not be empty.</td> </tr> <tr> <td>destinationCharactersError</td> <td>Characters used in the destinationPath must be in following character set [a-zA-Z0-9.!*'() _-].Spaces are not allowed at beginning or at end. Also, consecutive spaces are not allowed.</td> </tr> <tr> <td>noSuchSubtenant</td> <td>Provided subtenant does not belong to tenant.</td> </tr> <tr> <td>parameterTooLong</td> <td>Input parameter {name} must be no longer than {length} characters.</td> </tr> </table>

403 - Forbidden. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>subtenantIdNotAllowed</td> <td>Only tenants can address a subtenant's resource using subtenantId.</td> </tr> </table>

409 - Conflict. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>timeseriesImportJobConflict</td> <td>Existing timeseries bulk import job with id {id} found with same name {name}.</td> </tr> </table> schema: $ref: '#/definitions/Errors'

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

Parameters:

requestObject - - Object of type CreateTimeSeriesImportJobRequest {Parameters are ImportJob*}

Returns:

ImportJobResponse

Throws:

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

deleteTimeSeriesImportJob

public void deleteTimeSeriesImportJob(DeleteTimeSeriesImportJobRequest requestObject)
                               throws MindsphereException

Delete time series bulk import job by id. Delete completed time series bulk import job.

204 - deleted

400 - Bad request. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>jobDeleteError</td> <td>Import job can not be deleted as its status is not Success or Failed.</td> </tr> </table>

404 - Not Found. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>jobNotFound</td> <td>Import job with id {id} not found.</td> </tr> </table>

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

Parameters:

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

Throws:

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

queryTimeSeriesImportJobs

public ImportJobListResource queryTimeSeriesImportJobs(QueryTimeSeriesImportJobsRequest requestObject)
                                                throws MindsphereException

Query all time series bulk import jobs. Query all time series bulk import jobs currently existing, which are owned by the client's tenant or subtenant. If requester is tenant, all the import jobs for the tenant as well as its all subtenants are returned. If requester is a subtenant, all the iport jobs for the subtenant are returned. If tenant wants to filter results for a particular subtenant, filter query parameter subtenantId can be used. This filter query parameter is applicable only if the requester is tenant.

200 - A list of time series bulk import jobs.

400 - Bad request. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>noSuchSubtenant</td> <td>Provided subtenant does not belong to tenant.</td> </tr> </table>

403 - Forbidden. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>subtenantIdNotAllowed</td> <td>Only tenants can address a subtenant's resource using subtenantId.</td> </tr> </table>

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

Parameters:

requestObject - - Object of type QueryTimeSeriesImportJobsRequest {Parameters are page,size,filter}

Returns:

ImportJobListResource

Throws:

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

retrieveTimeSeriesImportJob

public ImportJobResponse retrieveTimeSeriesImportJob(RetrieveTimeSeriesImportJobRequest requestObject)
                                              throws MindsphereException

Retrieve status of time series bulk import job. Retrieve status of time series bulk import job.

200 - Time series bulk import job.

404 - Not Found. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>jobNotFound</td> <td>Import job with id {id} not found.</td> </tr> </table>

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

Parameters:

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

Returns:

ImportJobResponse

Throws:

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

retrieveTimeSeriesImportJobDetails

public ImportJobDetails retrieveTimeSeriesImportJobDetails(RetrieveTimeSeriesImportJobDetailsRequest requestObject)
                                                    throws MindsphereException

Retreive details of a time series bulk import job. Retreive details of a time series bulk import job. Details are only available once a job is not any longer in status PENDING.

200 - Time series bulk import job.

404 - Not Found. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>jobNotFound</td> <td>Import job with id {id} not found.</td> </tr> <tr> <td>jobDetailsNotFound</td> <td>No job details present while job status is PENDING</td> </tr> </table>

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

Parameters:

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

Returns:

ImportJobDetails

Throws:

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