Package com.cognite.client.servicesV1.util

Class TSIterationUtilities

java.lang.Object

com.cognite.client.servicesV1.util.TSIterationUtilities

public final class TSIterationUtilities
extends Object

Helper class for various utility methods for helping iterating over timeseries data points requests/responses

Constructor Summary

Constructors

Constructor	Description
TSIterationUtilities()

Method Summary

Modifier and Type	Method	Description
static int	calculateLimit(int originalLimit, int noTimeseries)	Calculates a limit setting for a timeseries datapoints request based on the baseline limit setting and the number of TS items in the request.
static Optional<Duration>	getAggregateGranularityDuration(Request requestParameters)	Parses the aggregate duration (minute, hour, day, etc.) from a TS datapoints request.
static Optional<Long>	getEndAsMillis(Request requestParameters)	Parses the end attribute from a TS datapoints request and returns it as millis since epoch.
static Optional<Long>	getStartAsMillis(Request requestParameters)	Parses the start attribute from a TS datapoints request and returns it as millis since epoch.

Methods inherited from class java.lang.Object

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

Constructor Detail

TSIterationUtilities

public TSIterationUtilities()

Method Detail

calculateLimit

public static int calculateLimit(int originalLimit,
                                 int noTimeseries)

Calculates a limit setting for a timeseries datapoints request based on the baseline limit setting and the number of TS items in the request. The baseline limit is the root parameter "limit" in the request specification.

Parameters:

originalLimit -

noTimeseries -

Returns:

getStartAsMillis

public static Optional<Long> getStartAsMillis(Request requestParameters)
                                       throws Exception

Parses the start attribute from a TS datapoints request and returns it as millis since epoch.

Parameters:

requestParameters -

Returns:

Throws:

Exception

getEndAsMillis

public static Optional<Long> getEndAsMillis(Request requestParameters)
                                     throws Exception

Parses the end attribute from a TS datapoints request and returns it as millis since epoch.

Parameters:

requestParameters -

Returns:

Throws:

Exception

getAggregateGranularityDuration

public static Optional<Duration> getAggregateGranularityDuration(Request requestParameters)
                                                          throws Exception

Parses the aggregate duration (minute, hour, day, etc.) from a TS datapoints request.

Parameters:

requestParameters -

Returns:

Throws:

Exception