public class AggregatesClient extends MindsphereAPIClient
Modifier and Type | Class and Description |
---|---|
static class |
AggregatesClient.ClientBuilder |
MindsphereAPIClient.Builder<T extends MindsphereAPIClient.Builder<T>>
credentials, restClientConfig, restTemplate
Constructor and Description |
---|
AggregatesClient(AggregatesClient.ClientBuilder builder) |
Modifier and Type | Method and Description |
---|---|
static AggregatesClient.ClientBuilder |
builder() |
List<Aggregates> |
getAggregateTimeseries(GetAggregateTimeseriesRequest requestObject)
read aggregated time series
Read time series data aggregated over a certain interval for a single entity and propertyset within the provided time range.
|
List<Aggregates> |
getAggregateTimeseries(String entity,
String propertyset,
String from,
String to,
BigDecimal 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.
|
public AggregatesClient(AggregatesClient.ClientBuilder builder)
public static AggregatesClient.ClientBuilder builder()
public List<Aggregates> getAggregateTimeseries(GetAggregateTimeseriesRequest requestObject) throws MindsphereException
200 - array of aggregated time series
400 - bad request
401 - unauthorized
404 - entity not found
0 - unexpected error
requestObject
- - Object of type GetAggregateTimeseriesRequest {Parameters are entity*,propertyset*,from*,to*,intervalValue*,intervalUnit*,select}MindsphereException
- if an error occurs while attempting to invoke the APIpublic List<Aggregates> getAggregateTimeseries(String entity, String propertyset, String from, String to, BigDecimal intervalValue, String intervalUnit, String select) throws MindsphereException
200 - array of aggregated time series
400 - bad request
401 - unauthorized
404 - entity not found
0 - unexpected error
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.MindsphereException
- if an error occurs while attempting to invoke the API