Package com.cognite.client.servicesV1

Class ConnectorServiceV1.ThreeDFileBinaryReader

java.lang.Object

com.cognite.client.servicesV1.ConnectorServiceV1.ConnectorBase

com.cognite.client.servicesV1.ConnectorServiceV1.ThreeDFileBinaryReader

All Implemented Interfaces:

Serializable

Enclosing class:

ConnectorServiceV1

public abstract static class ConnectorServiceV1.ThreeDFileBinaryReader
extends ConnectorServiceV1.ConnectorBase

Reads 3D file binaries from the Cognite API.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ThreeDFileBinaryReader()

Method Summary

Modifier and Type	Method	Description
ConnectorServiceV1.ThreeDFileBinaryReader	enableForceTempStorage(boolean enable)	Forces the use of temp storage for all binaries--not just the >200MiB ones.
ThreeDFileBinary	readThreeDFileBinaries(Request request)	Executes an item-based request to get file binaries and blocks the thread until all files have been downloaded.
CompletableFuture<ThreeDFileBinary>	readThreeDFileBinariesAsync(Request request)	Executes an item-based request to get file binaries asynchronously.
ConnectorServiceV1.ThreeDFileBinaryReader	withTempStoragePath(URI path)	Sets the temporary storage path for storing large file binaries.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ThreeDFileBinaryReader

public ThreeDFileBinaryReader()

Method Detail

enableForceTempStorage

public ConnectorServiceV1.ThreeDFileBinaryReader enableForceTempStorage(boolean enable)

Forces the use of temp storage for all binaries--not just the >200MiB ones.

Parameters:

enable -

Returns:

withTempStoragePath

public ConnectorServiceV1.ThreeDFileBinaryReader 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.

readThreeDFileBinaries

public ThreeDFileBinary readThreeDFileBinaries(Request request)
                                        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:

request -

Returns:

Throws:

Exception

readThreeDFileBinariesAsync

public CompletableFuture<ThreeDFileBinary> readThreeDFileBinariesAsync(Request request)
                                                                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:

request -

Returns:

Throws:

Exception