Package com.cognite.client.servicesV1.parser

Class SequenceParser

  • public class SequenceParser
extends Object
    This class contains a set of methods to help parsing Sequence objects between Cognite api representations (json and proto) and typed objects.

    • Constructor Detail

      • SequenceParser

        public SequenceParser()

    • Method Detail

      • parseSequenceMetadata

        public static com.cognite.client.dto.SequenceMetadata parseSequenceMetadata​(String json)
                                                                     throws Exception
        Parses a sequence header json string to SequenceMetadata proto object.
        Parameters:
        json - The json representation of a sequence header
        Returns:
        The sequence header as a typed object
        Throws:
        Exception

      • parseSequenceBody

        public static com.cognite.client.dto.SequenceBody parseSequenceBody​(String json)
                                                             throws Exception
        Parses a sequence body json string to SequenceBody proto object.
        Parameters:
        json - The json representation of a sequence body
        Returns:
        The sequence body as a typed object
        Throws:
        Exception

      • toRequestInsertItem

        public static Map<String,​Object> toRequestInsertItem​(com.cognite.client.dto.SequenceMetadata element)
        Builds a request insert item object from SequenceMetadata. An insert item object creates a new sequence header data object in the Cognite system.
        Parameters:
        element -
        Returns:

      • toRequestInsertItem

        public static Map<String,​Object> toRequestInsertItem​(com.cognite.client.dto.SequenceBody element)
                                                    throws Exception
        Builds a request insert item object from SequenceBody. An insert item object creates a set of new rows for a sequence in the Cognite system.
        Parameters:
        element -
        Returns:
        Throws:
        Exception

      • toRequestInsertItem

        public static com.google.common.collect.ImmutableMap<String,​Object> toRequestInsertItem​(com.cognite.client.dto.SequenceColumn element)
        Builds a request insert item object from SequenceColumn. An insert item object creates a new sequence column data object in the Cognite system.
        Parameters:
        element -
        Returns:

      • toRequestUpdateItem

        public static Map<String,​Object> toRequestUpdateItem​(com.cognite.client.dto.SequenceMetadata element)
        Builds a request update item object from SequenceMetadata. An update item object updates an existing sequence 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​(com.cognite.client.dto.SequenceMetadata element)
        Builds a request insert item object from SequenceMetadata. 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:

      • toRequestDeleteRowsItem

        public static Map<String,​Object> toRequestDeleteRowsItem​(com.cognite.client.dto.SequenceBody element)
        Builds a request delete rows object from SequenceBody. An delete rows object removes a set of rows from a sequence in the Cognite system.
        Parameters:
        element -
        Returns:

      • toString

        public static String toString​(com.cognite.client.dto.SequenceColumn.ValueType valueType)
        Returns the string representation of a SequenceColumn.ValueType.
        Parameters:
        valueType - The value type
        Returns:
        The string representation of the SequenceColumn.ValueType

      • parseValueType

        public static Optional<com.cognite.client.dto.SequenceColumn.ValueType> parseValueType​(String type)
        Tries to parse a string into a SequenceColumn.ValueType. If the string cannot be parsed, the returned Optional will be empty.
        Parameters:
        type - The string to be parsed into a SequenceColumn.ValueType
        Returns:
        an Optional carrying the SequenceColumn.ValueType