Package com.cognite.client.servicesV1

Class ConnectorServiceV1.FileBinaryReader

java.lang.Object
com.cognite.client.servicesV1.ConnectorServiceV1.ConnectorBase
com.cognite.client.servicesV1.ConnectorServiceV1.FileBinaryReader
All Implemented Interfaces:
Serializable
Enclosing class:
ConnectorServiceV1
public abstract static class ConnectorServiceV1.FileBinaryReader extends ConnectorServiceV1.ConnectorBase
Reads file binaries from the Cognite API.
See Also:

  • Constructor Details

    • FileBinaryReader

      public FileBinaryReader()

  • Method Details

    • enableForceTempStorage

      public ConnectorServiceV1.FileBinaryReader enableForceTempStorage(boolean enable)
      Forces the use of temp storage for all binaries--not just the >200MiB ones.
      Parameters:
      enable -
      Returns:

    • withTempStoragePath

      public ConnectorServiceV1.FileBinaryReader withTempStoragePath(URI path)
      Sets the temporary storage path for storing large file binaries. If the binary is >200 MiB it will be stored in temp storage instead of in memory. The following storage providers are supported: - Google Cloud Storage. Specify the temp path as gs://<my-storage-bucket>/<my-path>/. - Local (network) storage: file://localhost/home/files/, file:///home/files/, file:///c:/temp/
      Parameters:
      path - The URI to the temp storage
      Returns:
      a with temp storage configured.

    • readFileBinaries

      public List<ResponseItems<FileBinary>> readFileBinaries(Request items) throws Exception
      Executes an item-based request to get file binaries and blocks the thread until all files have been downloaded. We recommend reading a limited set of files per request, between 1 and 10--depending on the file size. If the request fails due to missing items, it will return a single ResultsItems.
      Parameters:
      items -
      Returns:
      Throws:
      Exception

    • readFileBinariesAsync

      public CompletableFuture<List<ResponseItems<FileBinary>>> readFileBinariesAsync(Request items) throws Exception
      Executes an item-based request to get file binaries asynchronously. We recommend reading a limited set of files per request, between 1 and 10--depending on the file size. If the request fails due to missing items, it will return a single ResultsItems.
      Parameters:
      items -
      Returns:
      Throws:
      Exception