Skip to content

Download

//trimblecloud-fileservice/trimblecloud.fileservice/FilesAPI/download

download

[JVM]
abstract fun download(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullfile: @NonNullFile): CompletableFuture<Boolean>

Download a file by id. Default filters are applied. chunkSize = 5MB, maxConcurrentRequests = 4.

Return

  • A future that resolves to true if the download is successful.

Parameters

JVM

spaceId- The space id.
fileId- The file id.
file- The file to download to.

Throws

TCPServiceException- If an error occurs due to API or network-related issues.
SDKClientException- If a client-side error occurs within the SDK.

[JVM]
abstract fun download(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullfile: @NonNullFile, @NonNullconfiguration: @NonNullTransferFileConfiguration): CompletableFuture<Boolean>

Download a file by id.

Return

  • A future that resolves to true if the download is successful.

Parameters

JVM

spaceId- The space id.
fileId- The file id.
file- The file to download to.
configuration- The configuration for the download.

Throws

TCPServiceException- If an error occurs due to API or network-related issues.
SDKClientException- If a client-side error occurs within the SDK.