Package com.cognite.client.servicesV1.parser

Class FileParser

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

    • Constructor Detail

      • FileParser

        public FileParser()

    • Method Detail

      • parseFileMetadata

        public static FileMetadata parseFileMetadata​(String json)
                                      throws Exception
        Parses a file metadata/header json string to FileMetadata proto object.
        Parameters:
        json -
        Returns:
        Throws:
        Exception

      • toRequestInsertItem

        public static Map<String,​Object> toRequestInsertItem​(FileMetadata element)
                                                    throws Exception
        Builds a request insert item object from FileMetadata. An insert item object creates a new file (metadata) data object in the Cognite system.
        Parameters:
        element -
        Returns:
        Throws:
        Exception

      • toRequestUpdateItem

        public static Map<String,​Object> toRequestUpdateItem​(FileMetadata element)
        Builds a request update item object from FileMetadata. An update item object updates an existing file (metadata) 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​(FileMetadata element)
        Builds a request insert item object from FileMetadata. A replace item object replaces an existing file (metadata) object with new values for all provided fields. Fields that are not in the update object are set to null.
        Parameters:
        element -
        Returns:

      • toRequestAddAssetIdsItem

        public static Map<String,​Object> toRequestAddAssetIdsItem​(FileMetadata element)
        Builds a request add assetId item object from FileMetadata. This method creates a special purpose item for adding assetIds to an existing file item. It is used for posting files with very a very high number of assetIds. The Cognite API has a limit of 1k assetIds per request so large assetId arrays need to be split into multiple update requests.
        Parameters:
        element -
        Returns: