Package com.cognite.client.servicesV1.parser

Class TimeseriesParser

java.lang.Object

com.cognite.client.servicesV1.parser.TimeseriesParser

public class TimeseriesParser
extends Object

This class contains a set of methods to help parsing timeseries object between Cognite api representations (json and proto) and typed objects.

Constructor Summary

Constructors

Constructor	Description
TimeseriesParser()

Method Summary

Modifier and Type	Method	Description
static List<TimeseriesPoint>	parseDataPointListItem(DataPointListItem item)	Parses a DataPointListItem (proto payload from the Cognite api) into a list of TimeseriesPoint
static List<TimeseriesPoint>	parseDataPointListItem(String json)
static TimeseriesMetadata	parseTimeseriesMetadata(String json)	Parses a time series header json string to TimeseriesMetadata proto object.
static Map<String,Object>	toRequestInsertItem(TimeseriesMetadata element)	Builds a request insert item object from TimeseriesMetadata.
static Map<String,Object>	toRequestReplaceItem(TimeseriesMetadata element)	Builds a request insert item object from TimeseriesMetadata.
static Map<String,Object>	toRequestUpdateItem(TimeseriesMetadata element)	Builds a request update item object from TimeseriesMetadata.

Methods inherited from class java.lang.Object

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

Constructor Details

TimeseriesParser

public TimeseriesParser()

Method Details

parseDataPointListItem

public static List<TimeseriesPoint> parseDataPointListItem(DataPointListItem item)

Parses a DataPointListItem (proto payload from the Cognite api) into a list of TimeseriesPoint

Returns:

parseDataPointListItem

public static List<TimeseriesPoint> parseDataPointListItem(String json)
                                                    throws Exception

Throws:

Exception

parseTimeseriesMetadata

public static TimeseriesMetadata parseTimeseriesMetadata(String json)
                                                  throws Exception

Parses a time series header json string to TimeseriesMetadata proto object.

Parameters:

json -

Returns:

Throws:

Exception

toRequestInsertItem

public static Map<String,Object> toRequestInsertItem(TimeseriesMetadata element)

Builds a request insert item object from TimeseriesMetadata. An insert item object creates a new TS header data object in the Cognite system.

Parameters:

element -

Returns:

toRequestUpdateItem

public static Map<String,Object> toRequestUpdateItem(TimeseriesMetadata element)

Builds a request update item object from TimeseriesMetadata. An update item object updates an existing TS header object with new values for all provided fields. Fields that are not in the update object retain their original value.

Parameters:

element -

Returns:

toRequestReplaceItem

public static Map<String,Object> toRequestReplaceItem(TimeseriesMetadata element)

Builds a request insert item object from TimeseriesMetadata. A replace item object replaces an existingTS header object with new values for all provided fields. Fields that are not in the update object are set to null.

Parameters:

element -

Returns: