com.siemens.mindsphere.sdk.iot.aggregate.apiclient

Class TimeseriesAggregateClient

Object

MindsphereAPIClient

TimeseriesAggregateClient

public class TimeseriesAggregateClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static TimeseriesAggregateClient.ClientBuilder	builder()
List<AggregateDetails>	getAggregateTimeseries(String entity, String propertyset, String from, String to, String intervalValue, String intervalUnit, String select) read aggregated time series Read time series data aggregated over a certain interval for a single entity and propertyset within the provided time range.

Methods inherited from class Object

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

Constructor Detail

TimeseriesAggregateClient

public TimeseriesAggregateClient(TimeseriesAggregateClient.ClientBuilder builder)

Method Detail

builder

public static TimeseriesAggregateClient.ClientBuilder builder()

getAggregateTimeseries

public List<AggregateDetails> getAggregateTimeseries(String entity,
                                                     String propertyset,
                                                     String from,
                                                     String to,
                                                     String intervalValue,
                                                     String intervalUnit,
                                                     String select)
                                              throws MindsphereException

read aggregated time series Read time series data aggregated over a certain interval for a single entity and propertyset within the provided time range.

200 - array of aggregated time series

400 - bad request

401 - unauthorized

404 - entity not found

0 - unexpected error

Parameters:

entity - Unique identifier of the entity.

propertyset - Name of the propertyset.

from - Beginning of the time range to read.

to - End of the time range to read.

intervalValue - Interval duration for the aggregates in intervalUnits.

intervalUnit - Interval duration unit for the aggregates.

select - Properties and fields to select. By default all properties and the availale fields are returned. Providing a property name selects all fields of a property. A property name followed by a ; and field name selects a specific field of a property.

Returns:

List<Aggregates>

Throws:

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