Package com.cognite.client

Class SequenceRows

java.lang.Object
com.cognite.client.SequenceRows
All Implemented Interfaces:
UpsertTarget<SequenceBody,SequenceBody>
public abstract class SequenceRows extends Object implements UpsertTarget<SequenceBody,SequenceBody>
This class represents the Cognite sequence body/rows api endpoint. It provides methods for reading and writing SequenceBody.

  • Field Details

    • LOG

      protected static final org.slf4j.Logger LOG

  • Constructor Details

    • SequenceRows

      public SequenceRows()

  • Method Details

    • 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.

      Example:

       
      List<SequenceBody> listResults = new ArrayList<>();
      client
          .sequences()
          .rows()
          .retrieve(Request.create.withRootParameter("id", 1L))
          .forEachRemaining(listResults::addAll);
      API Reference - Retrieve rows
      Parameters:
      requestParameters - the filters to use for retrieving sequences bodies.
      Returns:
      an Iterator to page through the results set.
      Throws:
      Exception
      See Also:

    • 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.

      Example:

       
      List<SequenceBody> listResults = new ArrayList<>();
      client
          .sequences()
          .rows()
          .retrieve(List.of(Request.create.withRootParameter("id", 1L)))
          .forEachRemaining(listResults::addAll);
      API Reference - Retrieve rows
      Parameters:
      requestParametersList - the filters to use for retrieving sequences bodies.
      Returns:
      an Iterator to page through the results set.
      Throws:
      Exception
      See Also:

    • retrieveComplete

      public Iterator<List<SequenceBody>> retrieveComplete(String... externalId) throws Exception
      Retrieves SequenceBody by externalId. Refer to retrieveComplete(List) for more information.

      Example:

       
      List<SequenceBody> listResults = new ArrayList<>();
      client
          .sequences()
          .rows()
          .retrieveComplete("1", "2")
          .forEachRemaining(listResults::addAll);
      API Reference - Retrieve rows
      Parameters:
      externalId - The externalIds to retrieve
      Returns:
      The retrieved sequence bodies.
      Throws:
      Exception
      See Also:

    • retrieveComplete

      public Iterator<List<SequenceBody>> retrieveComplete(long... id) throws Exception
      Retrieves SequenceBody by internal id. Refer to retrieveComplete(List) for more information.

      Example:

       
      List<SequenceBody> listResults = new ArrayList<>();
      client
          .sequences()
          .rows()
          .retrieveComplete(1, 2)
          .forEachRemaining(listResults::addAll);
      API Reference - Retrieve rows
      Parameters:
      id - The ids to retrieve
      Returns:
      The retrieved sequence bodies.
      Throws:
      Exception
      See Also:

    • retrieveComplete

      public Iterator<List<SequenceBody>> retrieveComplete(List<Item> items) throws Exception
      Retrieves SequenceBody by externalId / 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.

      Example:

       
      List<Item> items = List.of(Item.newBuilder().setExternalId("1").build());
      List<SequenceBody> retrievedSequenceBody = client.sequences().rows().retrieve(items);
      API Reference - Retrieve rows
      Parameters:
      items - The sequences externalId / id to retrieve rows for.
      Returns:
      The retrieved sequence rows / bodies.
      Throws:
      Exception
      See Also:

    • 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.

      Example:

       
      List<SequenceBody> sequenceBodies = // List of SequenceBody;
      client.sequences().rows().upsert(sequenceBodies);
      API Reference - Insert rows
      Specified by:
      upsert in interface UpsertTarget<SequenceBody,SequenceBody>
      Parameters:
      sequenceBodies - The sequences rows to upsert
      Returns:
      The upserted sequences rows
      Throws:
      Exception
      See Also:

    • uploadQueue

      public UploadQueue<SequenceBody,SequenceBody> uploadQueue()
      Returns an upload queue. The upload queue helps improve performance by batching items together before uploading them to Cognite Data Fusion. SequenceBody objects are quite large, so the queue is tuned with a default size of 10.
      Returns:
      The upload queue.

    • 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.

      Example:

       
     List<SequenceBody> sequenceRows = // List of SequenceBody;
     List<SequenceBody> deletedItemsResults = client.sequences().rows().delete(sequenceRows);
      API Reference - Delete rows
      Parameters:
      sequenceRows -
      Returns:
      The deleted rows
      Throws:
      Exception
      See Also:

    • 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.

      Example:

       
      List<String> partitions = buildPartitionsList(getClient().getClientConfig().getNoListPartitions());
      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.

      Example:

       
      Iterator<List<String>> result = listJson(resourceType, requestParameters, partitions);
      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
      See Also:

    • 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.

      Example:

       
      Iterator<List<String>> result = listJson(resourceType, requestParameters, partitionKey, partitions);
      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. Will ignore unknown ids by default.

      Example:

       
      Collection<Item> items = //Collection of items with ids;
      List<String> result = retrieveJson(resourceType, items);
      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
      See Also:

    • retrieveJson

      protected List<String> retrieveJson(ResourceType resourceType, Collection<Item> items, Map<String,Object> parameters) throws Exception
      Retrieve items by id. This version allows you to explicitly set additional parameters for the retrieve request. For example: <"ignoreUnknownIds", true> and <"fetchResources", true>.

      Example:

       
      Collection<Item> items = //Collection of items with ids;
      Map<String, Object> parameters = //Parameters;
      List<String> result = retrieveJson(resourceType, items, parameters);
      Parameters:
      resourceType - The item resource type (Event, Asset, etc.) to retrieve.
      items - The item(s) externalId / id to retrieve.
      parameters - Additional parameters for the request. For example <"ignoreUnknownIds", true>
      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.

      Example:

       
      Aggregate aggregateResult = aggregate(resourceType,requestParameters);
      Parameters:
      resourceType - The resource type to perform aggregation of.
      requestParameters - The request containing filters.
      Returns:
      The aggregation result.
      Throws:
      Exception
      See Also:

    • 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.

      Example:

       
      Request requestParams = addAuthInfo(request);
      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.

      Example:

       
      List<String> input = //List of json;
      List<Item> resultList = parseItems(input);
      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).

      Example:

       
      Collection<Item> itemList = //Collection of items;
      List<Map<String, Object>> result = toRequestItems(itemList);
      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.

      Example:

       
      Collection<Item> itemList = //Collection of items;
      List<Item> result = deDuplicate(itemList);
      Parameters:
      itemList -
      Returns:

    • itemsHaveId

      protected boolean itemsHaveId(Collection<Item> items)
      Returns true if all items contain either an externalId or id.

      Example:

       
      Collection<Item> items = //Collection of items;
      boolean result = itemsHaveId(items);
      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.

      Example:

       
      Collection<Item> items = //Collection of items;
      Map<String, Item> result = mapItemToId(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.

      Example:

       
      String json = //String of json object
      String result = parseString(json, "name");
      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.

      Example:

       
      String json = //String of json object
      String result = parseName(json);
      Parameters:
      json - the json to parse
      Returns:
      The name value