Package com.cognite.client

Class Sequences

  • public abstract class Sequences
extends Object
    This class represents the Cognite sequences api endpoint. It provides for reading an writing SequenceMetadata

    • Field Detail

      • LOG

        protected static final org.slf4j.Logger LOG

    • Constructor Detail

      • Sequences

        public Sequences()

    • Method Detail

      • of

        public static Sequences of​(CogniteClient client)
        Construct a new Sequences 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 fir cinfiguration settings.
        Returns:
        The sequences api object.

      • rows

        public SequenceRows rows()
        Returns SequenceRows representing the sequences data / rows api.
        Returns:
        The sequences data / rows api object.

      • list

        public Iterator<List<com.cognite.client.dto.SequenceMetadata>> list​(Request requestParameters)
                                                             throws Exception
        Return all SequenceMetadata object that matches the filters set in the SequenceMetadata. 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 yout own data structure. The sequences 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
        Returns:
        an Iterator to page through the results set.
        Throws:
        Exception

      • list

        public Iterator<List<com.cognite.client.dto.SequenceMetadata>> list​(Request requestParameters,
                                                                    String... partitions)
                                                             throws Exception
        Returns all SequenceMetadata objects that matches the filters set in the Request for the specified partitions. This method is intended for advanced use cases you need direct control over the individual partitions. For example, when using the SDK in a distributed environment. 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.
        Parameters:
        requestParameters - The filters to use for retrieving the timeseries.
        partitions - The partitions to include
        Returns:
        an Iterator to page through the results set.
        Throws:
        Exception

      • retrieve

        public List<com.cognite.client.dto.SequenceMetadata> retrieve​(List<com.cognite.client.dto.Item> items)
                                                       throws Exception
        Retrieve sequences by id.
        Parameters:
        items - The item(s) externalId / id to retrieve
        Returns:
        The retrieved sequences
        Throws:
        Exception

      • aggregate

        public com.cognite.client.dto.Aggregate aggregate​(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. Multiple aggregation types are supported, Please refer to the Cognite API specification for more information on the possible settings.
        Parameters:
        requestParameters - The filtering and aggregates specification.
        Returns:
        The aggregation results.
        Throws:
        Exception
        See Also:
        Cognite API v1 specification

      • upsert

        public List<com.cognite.client.dto.SequenceMetadata> upsert​(List<com.cognite.client.dto.SequenceMetadata> sequences)
                                                     throws Exception
        Creates or update a set of SequenceMetadata objects. If it is a new SequenceMetadata object already exists in Cognite Data Fusion, it will be updated. The update behaviour is specified via the update mode in the ClientConfig settings.
        Parameters:
        sequences - The sequences to upsert
        Returns:
        The upserted sequences
        Throws:
        Exception

      • delete

        public List<com.cognite.client.dto.Item> delete​(List<com.cognite.client.dto.Item> sequences)
                                         throws Exception
        Deletes a set of Sequences. The sequences to delete are identified via their externalId / id by submitting a list of Item.
        Parameters:
        sequences - A list of Item representing the sequences (externalId / id) to be deleted
        Returns:
        The deleted sequences via Item
        Throws:
        Exception

      • 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<com.cognite.client.dto.Item> items)
                             throws Exception
        Retrieve items by id. Will ignore unknown ids by default.
        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

      • retrieveJson

        protected List<String> retrieveJson​(ResourceType resourceType,
                                    Collection<com.cognite.client.dto.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>.
        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 com.cognite.client.dto.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

      • parseItems

        protected List<com.cognite.client.dto.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<com.cognite.client.dto.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<com.cognite.client.dto.Item> deDuplicate​(Collection<com.cognite.client.dto.Item> itemList)
        De-duplicates a collection of Item.
        Parameters:
        itemList -
        Returns:

      • itemsHaveId

        protected boolean itemsHaveId​(Collection<com.cognite.client.dto.Item> items)
        Returns true if all items contain either an externalId or id.
        Parameters:
        items -
        Returns:

      • mapItemToId

        protected Map<String,​com.cognite.client.dto.Item> mapItemToId​(Collection<com.cognite.client.dto.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