Package com.cognite.client

Class SequenceRows

java.lang.Object

com.cognite.client.SequenceRows

public abstract class SequenceRows
extends Object

This class represents the Cognite sequence body/rows api endpoint. It provides methods for reading and writing SequenceBody.

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor	Description
SequenceRows()

Method Summary

Modifier and Type	Method	Description
protected Request	addAuthInfo(Request request)	Adds the required authentication information into the request object.
protected Aggregate	aggregate(ResourceType resourceType, Request requestParameters)	Performs an item aggregation request to Cognite Data Fusion.
protected List<String>	buildPartitionsList(int noPartitions)	Builds an array of partition specifications for parallel retrieval from the Cognite api.
protected List<Item>	deDuplicate(Collection<Item> itemList)	De-duplicates a collection of Item.
List<SequenceBody>	delete(List<SequenceBody> sequenceRows)	Deletes the given rows of the sequence(s).
abstract CogniteClient	getClient()
protected Iterator<CompletableFuture<ResponseItems<String>>>	getListResponseIterator(ResourceType resourceType, Request requestParameters)
protected boolean	itemsHaveId(Collection<Item> items)	Returns true if all items contain either an externalId or id.
protected Iterator<List<String>>	listJson(ResourceType resourceType, Request requestParameters, String... partitions)	Will return the results from a list / filter api endpoint.
protected Iterator<List<String>>	listJson(ResourceType resourceType, Request requestParameters, String partitionKey, String... partitions)	Will return the results from a list / filter api endpoint.
protected Map<String,Item>	mapItemToId(Collection<Item> items)	Maps all items to their externalId (primary) or id (secondary).
static SequenceRows	of(CogniteClient client)	Construct a new SequenceRows object using the provided configuration.
protected List<Item>	parseItems(List<String> input)	Parses a list of item object in json representation to typed objects.
protected String	parseName(String json)	Returns the name attribute value from a json input.
protected String	parseString(String itemJson, String fieldName)	Try parsing the specified Json path as a String.
Iterator<List<SequenceBody>>	retrieve(Request requestParameters)	Returns all SequenceBody objects (i.e.
Iterator<List<SequenceBody>>	retrieve(List<Request> requestParametersList)	Returns all SequenceBody objects (i.e.
Iterator<List<SequenceBody>>	retrieveComplete(List<Item> items)	Retrieves SequenceBody by id.
protected List<String>	retrieveJson(ResourceType resourceType, Collection<Item> items)	Retrieve items by id.
protected List<Map<String,Object>>	toRequestItems(Collection<Item> itemList)	Converts a list of Item to a request object structure (that can later be parsed to Json).
List<SequenceBody>	upsert(List<SequenceBody> sequenceBodies)	Creates or updates a set of SequenceBody objects.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.slf4j.Logger LOG

Constructor Detail

SequenceRows

public SequenceRows()

Method Detail

of

public static SequenceRows of(CogniteClient client)

Construct a new SequenceRows object using the provided configuration. This method is intended for internal use--SDK clients should always use CogniteClient as the entry point to this class.

Parameters:

client - The CogniteClient to use for configuration settings.

Returns:

the assets api object.

retrieve

public Iterator<List<SequenceBody>> retrieve(Request requestParameters)
                                      throws Exception

Returns all SequenceBody objects (i.e. sequences rows x columns) that matches the specification set in the Request. The results are paged through / iterated over via an Iterator--the entire results set is not buffered in memory, but streamed in "pages" from the Cognite api. If you need to buffer the entire results set, then you have to stream these results into your own data structure. The sequence bodies are retrieved using multiple, parallel request streams towards the Cognite api. The number of parallel streams are set in the ClientConfig.

Parameters:

requestParameters - the filters to use for retrieving sequences bodies.

Returns:

an Iterator to page through the results set.

Throws:

Exception

retrieve

public Iterator<List<SequenceBody>> retrieve(List<Request> requestParametersList)
                                      throws Exception

Returns all SequenceBody objects (i.e. sequences rows x columns) that matches the specification set in the collection of Request. By submitting a collection of Request, the requests will be submitted in parallel to Cognite Data Fusion, potentially increasing the overall I/O performance. The results are paged through / iterated over via an Iterator--the entire results set is not buffered in memory, but streamed in "pages" from the Cognite api. If you need to buffer the entire results set, then you have to stream these results into your own data structure. The sequence bodies are retrieved using multiple, parallel request streams towards the Cognite api. The number of parallel streams are set in the ClientConfig.

Parameters:

requestParametersList - the filters to use for retrieving sequences bodies.

Returns:

an Iterator to page through the results set.

Throws:

Exception

retrieveComplete

public Iterator<List<SequenceBody>> retrieveComplete(List<Item> items)
                                              throws Exception

Retrieves SequenceBody by id. The entire Sequence body (i.e. all rows and columns) will be retrieved. The sequence bodies are retrieved using multiple, parallel request streams towards the Cognite api. The number of parallel streams are set in the ClientConfig.

Parameters:

items - The sequences externalId / id to retrieve rows for.

Returns:

The retrieved sequence rows / bodies.

Throws:

Exception

upsert

public List<SequenceBody> upsert(List<SequenceBody> sequenceBodies)
                          throws Exception

Creates or updates a set of SequenceBody objects. A SequenceBody carries the data cells (columns x rows) to be upserted to a sequence. If the main sequence object hasn't been created in Cognite Data Fusion yet (maybe because of a large job where both sequence headers and bodies are upserted in parallel), this method will create the sequence objects based on the information carried in the SequenceBody. The algorithm runs as follows: 1. Write all SequenceBody objects to the Cognite API. 2. If one (or more) of the objects fail, check if it is because of missing sequence objects--create temp headers. 3. Retry the failed SequenceBody objects.

Parameters:

sequenceBodies - The sequences rows to upsert

Returns:

The upserted sequences rows

Throws:

Exception

delete

public List<SequenceBody> delete(List<SequenceBody> sequenceRows)
                          throws Exception

Deletes the given rows of the sequence(s). This method will delete the rows specified via the sequence externalId/id + row number list in the input SequenceBody objects. You don't need to specify columns or values. All columns will always be removed from the listed row numbers.

Parameters:

sequenceRows -

Returns:

The deleted rows

Throws:

Exception

getClient

public abstract CogniteClient getClient()

buildPartitionsList

protected List<String> buildPartitionsList(int noPartitions)

Builds an array of partition specifications for parallel retrieval from the Cognite api. This specification is used as a parameter together with the filter / list endpoints. The number of partitions indicate the number of parallel read streams. Employ one partition specification per read stream.

Parameters:

noPartitions - The total number of partitions

Returns:

a List of partition specifications

listJson

protected Iterator<List<String>> listJson(ResourceType resourceType,
                                          Request requestParameters,
                                          String... partitions)
                                   throws Exception

Will return the results from a list / filter api endpoint. For example, the filter assets endpoint. The results are paged through / iterated over via an Iterator--the entire results set is not buffered in memory, but streamed in "pages" from the Cognite api. If you need to buffer the entire results set, then you have to stream these results into your own data structure. This method support parallel retrieval via a set of partition specifications. The specified partitions will be collected and merged together before being returned via the Iterator.

Parameters:

resourceType - The resource type to query / filter / list. Ex. event, asset, time series.

requestParameters - The query / filter specification. Follows the Cognite api request parameters.

partitions - An optional set of partitions to read via.

Returns:

an Iterator over the results set.

Throws:

Exception

listJson

protected Iterator<List<String>> listJson(ResourceType resourceType,
                                          Request requestParameters,
                                          String partitionKey,
                                          String... partitions)
                                   throws Exception

Will return the results from a list / filter api endpoint. For example, the filter assets endpoint. The results are paged through / iterated over via an Iterator--the entire results set is not buffered in memory, but streamed in "pages" from the Cognite api. If you need to buffer the entire results set, then you have to stream these results into your own data structure. This method support parallel retrieval via a set of partition specifications. The specified partitions will be collected and merged together before being returned via the Iterator.

Parameters:

resourceType - The resource type to query / filter / list. Ex. event, asset, time series.

requestParameters - The query / filter specification. Follows the Cognite api request parameters.

partitionKey - The key to use for the partitions in the read request. For example partition or cursor.

partitions - An optional set of partitions to read via.

Returns:

an Iterator over the results set.

Throws:

Exception

retrieveJson

protected List<String> retrieveJson(ResourceType resourceType,
                                    Collection<Item> items)
                             throws Exception

Retrieve items by id.

Parameters:

resourceType - The item resource type (Event, Asset, etc.) to retrieve.

items - The item(s) externalId / id to retrieve.

Returns:

The items in Json representation.

Throws:

Exception

aggregate

protected Aggregate aggregate(ResourceType resourceType,
                              Request requestParameters)
                       throws Exception

Performs an item aggregation request to Cognite Data Fusion. The default aggregation is a total item count based on the (optional) filters in the request. Some resource types, for example Event, supports multiple types of aggregation.

Parameters:

resourceType - The resource type to perform aggregation of.

requestParameters - The request containing filters.

Returns:

The aggregation result.

Throws:

Exception

See Also:

Cognite API v1 specification

addAuthInfo

protected Request addAuthInfo(Request request)
                       throws Exception

Adds the required authentication information into the request object. If the request object already have complete auth info nothing will be added. The following authentication schemes are supported: 1) API key. When using an api key, this service will look up the corresponding project/tenant to issue requests to.

Parameters:

request - The request to enrich with auth information.

Returns:

The request parameters with auth info added to it.

Throws:

Exception

getListResponseIterator

protected Iterator<CompletableFuture<ResponseItems<String>>> getListResponseIterator(ResourceType resourceType,
                                                                                     Request requestParameters)
                                                                              throws Exception

Throws:

Exception

parseItems

protected List<Item> parseItems(List<String> input)
                         throws Exception

Parses a list of item object in json representation to typed objects.

Parameters:

input - the item list in Json string representation

Returns:

the parsed item objects

Throws:

Exception

toRequestItems

protected List<Map<String,Object>> toRequestItems(Collection<Item> itemList)

Converts a list of Item to a request object structure (that can later be parsed to Json).

Parameters:

itemList - The items to parse.

Returns:

The items in request item object form.

deDuplicate

protected List<Item> deDuplicate(Collection<Item> itemList)

De-duplicates a collection of Item.

Parameters:

itemList -

Returns:

itemsHaveId

protected boolean itemsHaveId(Collection<Item> items)

Returns true if all items contain either an externalId or id.

Parameters:

items -

Returns:

mapItemToId

protected Map<String,Item> mapItemToId(Collection<Item> items)

Maps all items to their externalId (primary) or id (secondary). If the id function does not return any identity, the item will be mapped to the empty string. Via the identity mapping, this function will also perform deduplication of the input items.

Parameters:

items - the items to map to externalId / id.

Returns:

the Map with all items mapped to externalId / id.

parseString

protected String parseString(String itemJson,
                             String fieldName)

Try parsing the specified Json path as a String.

Parameters:

itemJson - The Json string

fieldName - The Json path to parse

Returns:

The Json path as a String.

parseName

protected String parseName(String json)

Returns the name attribute value from a json input.

Parameters:

json - the json to parse

Returns:

The name value