com.siemens.mindsphere.sdk.timeseries.apiclient

Class TimeSeriesClient

Object

MindsphereAPIClient

TimeSeriesClient

public class TimeSeriesClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static TimeSeriesClient.ClientBuilder	builder()
void	deleteTimeseries(DeleteTimeseriesRequest requestObject) delete time series Delete time series data for a single entity and propertyset within a given time range.
void	deleteTimeseries(String entity, String propertysetname, String from, String to) delete time series Delete time series data for a single entity and propertyset within a given time range.
List<Timeseries>	getTimeseries(GetTimeseriesRequest requestObject) read time series Read time series data for a single entity and propertyset.
List<Timeseries>	getTimeseries(String entity, String propertysetname, String from, String to, Integer limit, String select) read time series Read time series data for a single entity and propertyset.
void	putTimeseries(PutTimeseriesRequest requestObject) write or update time series Write or update time series data for a single entity and propertyset.
void	putTimeseries(String entity, String propertysetname, List<Timeseries> timeseries) write or update time series Write or update time series data for a single entity and propertyset.

Methods inherited from class Object

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

Constructor Detail

TimeSeriesClient

public TimeSeriesClient(TimeSeriesClient.ClientBuilder builder)

Method Detail

builder

public static TimeSeriesClient.ClientBuilder builder()

deleteTimeseries

public void deleteTimeseries(DeleteTimeseriesRequest requestObject)
                      throws MindsphereException

delete time series Delete time series data for a single entity and propertyset within a given time range. Data for all properties within a propertyset is deleted.

204 - deleted

400 - bad request

401 - unauthorized

404 - entity not found

0 - unexpected error

Parameters:

requestObject - - Object of type DeleteTimeseriesRequest {Parameters are entity*,propertysetname*,from*,to*}

Throws:

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

getTimeseries

public List<Timeseries> getTimeseries(GetTimeseriesRequest requestObject)
                               throws MindsphereException

read time series Read time series data for a single entity and propertyset. Returns data for a specified time range. Returns the latest value if no range is provided.

200 - array of time series

400 - bad request, in case of invalid parameters

401 - unauthorized

404 - entity not found

0 - unexpected error

Parameters:

requestObject - - Object of type GetTimeseriesRequest {Parameters are entity*,propertysetname*,from,to,limit,select}

Returns:

List<Timeseries>

Throws:

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

putTimeseries

public void putTimeseries(PutTimeseriesRequest requestObject)
                   throws MindsphereException

write or update time series Write or update time series data for a single entity and propertyset. Existing time series data is overwritten. Data for all properties within a propertyset needs to be provided together.

204 - timeseries written

400 - bad request, in case the resource is invalid

401 - unauthorized

404 - entity not found

429 - too many requests

0 - unexpected error

Parameters:

requestObject - - Object of type PutTimeseriesRequest {Parameters are entity*,propertysetname*,timeseries*}

Throws:

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

deleteTimeseries

public void deleteTimeseries(String entity,
                             String propertysetname,
                             String from,
                             String to)
                      throws MindsphereException

delete time series Delete time series data for a single entity and propertyset within a given time range. Data for all properties within a propertyset is deleted.

204 - deleted

400 - bad request

401 - unauthorized

404 - entity not found

0 - unexpected error

Parameters:

entity - unique identifier of the entity

propertysetname - name of the propertyset

from - beginning of the timerange to delete (exclusive)

to - end of the timerange to delete (inclusive)

Throws:

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

getTimeseries

public List<Timeseries> getTimeseries(String entity,
                                      String propertysetname,
                                      String from,
                                      String to,
                                      Integer limit,
                                      String select)
                               throws MindsphereException

read time series Read time series data for a single entity and propertyset. Returns data for a specified time range. Returns the latest value if no range is provided.

200 - array of time series

400 - bad request, in case of invalid parameters

401 - unauthorized

404 - entity not found

0 - unexpected error

Parameters:

entity - unique identifier of the entity

propertysetname - name of the propertyset

from - beginning of the time range to read (exclusive)

to - end of the time range to read (inclusive)

limit - maximum number of entries to read

select - select fields to return

Returns:

List<Timeseries>

Throws:

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

putTimeseries

public void putTimeseries(String entity,
                          String propertysetname,
                          List<Timeseries> timeseries)
                   throws MindsphereException

write or update time series Write or update time series data for a single entity and propertyset. Existing time series data is overwritten. Data for all properties within a propertyset needs to be provided together.

204 - timeseries written

400 - bad request, in case the resource is invalid

401 - unauthorized

404 - entity not found

429 - too many requests

0 - unexpected error

Parameters:

entity - unique identifier of the entity

propertysetname - name of the propertyset

timeseries - time series data array

Throws:

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