Overview

//trimblecloud-fileservice/trimblecloud.fileservice/FilesAPI

FilesAPI

[JVM]
interface FilesAPI

Represents all operations that can be performed on a file.

Functions

Name	Summary
checkin	[JVM] abstract fun checkin(@NonNullrequest: @NonNullCheckinFileRequest): CompletableFuture<Response<File>> Checking in a file will allow other actors to create a new version or perform other mutation operations.
checkinWithMinimalResponse	[JVM] abstract fun checkinWithMinimalResponse(@NonNullrequest: @NonNullCheckinFileRequest): CompletableFuture<Response<MinimalFile>> Checking in a file will allow other actors to create a new version or perform other mutation operations.
checkout	[JVM] abstract fun checkout(@NonNullrequest: @NonNullCheckoutFileRequest): CompletableFuture<Response<File>> abstract fun checkout(@NonNullrequest: @NonNullCheckoutFileRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<File>> Checking out a file will prevent other actors from creating a new version or other mutation operations.
checkoutWithMinimalResponse	[JVM] abstract fun checkoutWithMinimalResponse(@NonNullrequest: @NonNullCheckoutFileRequest): CompletableFuture<Response<MinimalFile>> abstract fun checkoutWithMinimalResponse(@NonNullrequest: @NonNullCheckoutFileRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<MinimalFile>> Checking out a file will prevent other actors from creating a new version or other mutation operations.
completeMultipart	[JVM] abstract fun completeMultipart(@NonNullrequest: @NonNullCreateCompleteMultipartRequest): CompletableFuture<Response<UploadDetails>> Mark the multipart file upload status to be COMPLETED
copy	[JVM] abstract fun copy(@NonNullrequest: @NonNullCopyFileRequest): CompletableFuture<Response<FileJobResponse>> abstract fun copy(@NonNullrequest: @NonNullCopyFileRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<FileJobResponse>> abstract fun copy(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNulltargetParentId: @NonNullUUID): CompletableFuture<Response<FileJobResponse>> abstract fun copy(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNulltargetParentId: @NonNullUUID, @NonNullparams: @NonNullCopyFileParams): CompletableFuture<Response<FileJobResponse>> Copies a file from one folder to another within the given space.
copyWithMinimalResponse	[JVM] abstract fun copyWithMinimalResponse(@NonNullrequest: @NonNullCopyFileRequest): CompletableFuture<Response<MinimalFileJobResponse>> abstract fun copyWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNulltargetParentId: @NonNullUUID): CompletableFuture<Response<MinimalFileJobResponse>> abstract fun copyWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNulltargetParentId: @NonNullUUID, @NonNullparams: @NonNullCopyFileParams): CompletableFuture<Response<MinimalFileJobResponse>> Copies a file from one folder to another within the given space and returns minimal response. [JVM] abstract fun copyWithMinimalResponse(@NonNullrequest: @NonNullCopyFileRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<MinimalFileJobResponse>> Copies a file from one folder to another within the given space and returns minimal response..
createFileUpload	[JVM] abstract fun createFileUpload(@NonNullspaceId: @NonNullUUID, @NonNullrequest: @NonNullCreateFileUploadRequest): CompletableFuture<Response<UploadDetails>> abstract fun createFileUpload(@NonNullspaceId: @NonNullUUID, @NonNullrequest: @NonNullCreateFileUploadRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<UploadDetails>> Generates a pre-signed upload url for the given name and parentId.
createOrUpdateLinks	[JVM] abstract fun createOrUpdateLinks(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullfileMajorVersion: Int, @NonNullsupportFiles: @NonNullSupportFileLinkRequest): CompletableFuture<Response<File>> Link support files to a file.
createOrUpdateLinksWithMinimalResponse	[JVM] abstract fun createOrUpdateLinksWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullfileMajorVersion: Int, @NonNullsupportFiles: @NonNullSupportFileLinkRequest): CompletableFuture<Response<MinimalFile>> Link support files to a file and return a minimal response.
createPackageUpload	[JVM] abstract fun createPackageUpload(@NonNullrequest: @NonNullCreatePackageUploadRequest): CompletableFuture<Response<UploadDetails>> abstract fun createPackageUpload(@NonNullrequest: @NonNullCreatePackageUploadRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<UploadDetails>> Creates a package upload.
createSupportFileUpload	[JVM] abstract fun createSupportFileUpload(@NonNullspaceId: @NonNullUUID, @NonNullrequest: @NonNullCreateSupportFileUploadRequest): CompletableFuture<Response<UploadDetails>> abstract fun createSupportFileUpload(@NonNullspaceId: @NonNullUUID, @NonNullrequest: @NonNullCreateSupportFileUploadRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<UploadDetails>> Generates a pre-signed upload url for the given name and parentId.
delete	[JVM] abstract fun delete(@NonNullrequest: @NonNullDeleteFileRequest): CompletableFuture<Response<JobInfo>> abstract fun delete(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID): CompletableFuture<Response<JobInfo>> abstract fun delete(@NonNullrequest: @NonNullDeleteFileRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<JobInfo>> abstract fun delete(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, permanent: Boolean): CompletableFuture<Response<JobInfo>> Deletes the file.
download	[JVM] abstract fun download(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullfile: @NonNullFile): CompletableFuture<Boolean> abstract fun download(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullfile: @NonNullFile, @NonNullconfiguration: @NonNullTransferFileConfiguration): CompletableFuture<Boolean> Download a file by id.
get	[JVM] abstract fun get(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString): CompletableFuture<Response<File>> abstract fun get(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString, @NonNullparams: @NonNullGetFileParams): CompletableFuture<Response<File>> Get file by path. [JVM] abstract fun get(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID): CompletableFuture<Response<File>> abstract fun get(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullparams: @NonNullGetFileParams): CompletableFuture<Response<File>> Get file by id.
getUploadDetails	[JVM] abstract fun getUploadDetails(@NonNullspaceId: @NonNullUUID, @NonNulluploadId: @NonNullUUID): CompletableFuture<Response<UploadDetails>> Retrieve the upload details by Id Default filters are applied. [JVM] abstract fun getUploadDetails(@NonNullspaceId: @NonNullUUID, @NonNulluploadId: @NonNullUUID, @NonNullurlDuration: @NonNullString): CompletableFuture<Response<UploadDetails>> Retrieve the upload details by Id [JVM] abstract fun getUploadDetails(@NonNullspaceId: @NonNullUUID, @NonNulluploadId: @NonNullUUID, @NonNullparams: @NonNullGetUploadDetailsParams): CompletableFuture<Response<UploadDetails>> Retrieve the upload details by Id with parameters.
getVersion	[JVM] abstract fun getVersion(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString, @NonNullversion: @NonNullString): CompletableFuture<Response<File>> abstract fun getVersion(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString, @NonNullversion: @NonNullString, @NonNullparams: @NonNullGetFileParams): CompletableFuture<Response<File>> Get a specific version of a file by path. [JVM] abstract fun getVersion(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullversion: @NonNullString): CompletableFuture<Response<File>> abstract fun getVersion(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullversion: @NonNullString, @NonNullparams: @NonNullGetFileParams): CompletableFuture<Response<File>> Get a specific version of a file by ID.
getVersionWithMinimalResponse	[JVM] abstract fun getVersionWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString, @NonNullversion: @NonNullString): CompletableFuture<Response<MinimalFile>> abstract fun getVersionWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString, @NonNullversion: @NonNullString, @NonNullparams: @NonNullGetFileParams): CompletableFuture<Response<MinimalFile>> Get a specific version of a file by path with minimal response. [JVM] abstract fun getVersionWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullversion: @NonNullString): CompletableFuture<Response<MinimalFile>> Get a specific version of a file by ID with minimal response. [JVM] abstract fun getVersionWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullversion: @NonNullString, @NonNullparams: @NonNullGetFileParams): CompletableFuture<Response<MinimalFile>> Get a specific version of a file by Id with minimal response.
getWithMinimalResponse	[JVM] abstract fun getWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString): CompletableFuture<Response<MinimalFile>> abstract fun getWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString, @NonNullparams: @NonNullGetFileParams): CompletableFuture<Response<MinimalFile>> Get file by path with minimal response. [JVM] abstract fun getWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID): CompletableFuture<Response<MinimalFile>> abstract fun getWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullparams: @NonNullGetFileParams): CompletableFuture<Response<MinimalFile>> Get file by id with minimal response.
listManifest	[JVM] abstract fun listManifest(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID): CompletableFuture<Response<ManifestFileList>> abstract fun listManifest(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullparams: @NonNullListManifestParams): CompletableFuture<Response<ManifestFileList>> Lists all files from inside the unpacked fileset.
listResources	[JVM] abstract fun listResources(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString): CompletableFuture<Response<FileList>> abstract fun listResources(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString, @NonNullparams: @NonNullListFileParams): CompletableFuture<Response<FileList>> Lists all resources (support files) of a file by path. [JVM] abstract fun listResources(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID): CompletableFuture<Response<FileList>> abstract fun listResources(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullparams: @NonNullListFileParams): CompletableFuture<Response<FileList>> Lists all resources (support files) of a file in a space by file identifier.
listResourcesWithMinimalResponse	[JVM] abstract fun listResourcesWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString): CompletableFuture<Response<MinimalFileList>> abstract fun listResourcesWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString, @NonNullparams: @NonNullListFileParams): CompletableFuture<Response<MinimalFileList>> Lists all resources (support files) of a file by path with minimal response. [JVM] abstract fun listResourcesWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID): CompletableFuture<Response<MinimalFileList>> abstract fun listResourcesWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullparams: @NonNullListFileParams): CompletableFuture<Response<MinimalFileList>> Lists all resources (support files) of a file in a space by file identifier with minimal response.
listVersions	[JVM] abstract fun listVersions(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString): CompletableFuture<Response<FileList>> abstract fun listVersions(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString, @NonNullparams: @NonNullListFileParams): CompletableFuture<Response<FileList>> Get all versions of a file by path. [JVM] abstract fun listVersions(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID): CompletableFuture<Response<FileList>> abstract fun listVersions(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullparams: @NonNullListFileParams): CompletableFuture<Response<FileList>> Get all versions of a file by id.
listVersionsWithMinimalResponse	[JVM] abstract fun listVersionsWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString): CompletableFuture<Response<MinimalFileList>> abstract fun listVersionsWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString, @NonNullparams: @NonNullListFileParams): CompletableFuture<Response<MinimalFileList>> Get all versions of a file by path with minimal response. [JVM] abstract fun listVersionsWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID): CompletableFuture<Response<MinimalFileList>> abstract fun listVersionsWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullparams: @NonNullListFileParams): CompletableFuture<Response<MinimalFileList>> Get all versions of a file by id with minimal response.
lock	[JVM] abstract fun lock(@NonNullrequest: @NonNullLockFileRequest): CompletableFuture<Response<File>> Lock a file
lockWithMinimalResponse	[JVM] abstract fun lockWithMinimalResponse(@NonNullrequest: @NonNullLockFileRequest): CompletableFuture<Response<MinimalFile>> Lock a file and return a minimal response.
move	[JVM] abstract fun move(@NonNullrequest: @NonNullMoveFileRequest): CompletableFuture<Response<File>> abstract fun move(@NonNullrequest: @NonNullMoveFileRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<File>> abstract fun move(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNulltargetParentId: @NonNullUUID): CompletableFuture<Response<File>> Move a file to a new location within the same space.
moveWithMinimalResponse	[JVM] abstract fun moveWithMinimalResponse(@NonNullrequest: @NonNullMoveFileRequest): CompletableFuture<Response<MinimalFile>> abstract fun moveWithMinimalResponse(@NonNullrequest: @NonNullMoveFileRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<MinimalFile>> abstract fun moveWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNulltargetParentId: @NonNullUUID): CompletableFuture<Response<MinimalFile>> Move a file to a new location within the same space and return a minimal response.
rename	[JVM] abstract fun rename(@NonNullrequest: @NonNullRenameFileRequest): CompletableFuture<Response<File>> abstract fun rename(@NonNullrequest: @NonNullRenameFileRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<File>> abstract fun rename(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullname: @NonNullString): CompletableFuture<Response<File>> Rename a file within the same space.
renameWithMinimalResponse	[JVM] abstract fun renameWithMinimalResponse(@NonNullrequest: @NonNullRenameFileRequest): CompletableFuture<Response<MinimalFile>> abstract fun renameWithMinimalResponse(@NonNullrequest: @NonNullRenameFileRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<MinimalFile>> abstract fun renameWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullname: @NonNullString): CompletableFuture<Response<MinimalFile>> Rename a file within the same space and return a minimal response.
restore	[JVM] abstract fun restore(@NonNullrequest: @NonNullRestoreFileRequest): CompletableFuture<Response<FileJobResponse>> abstract fun restore(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID): CompletableFuture<Response<FileJobResponse>> abstract fun restore(@NonNullrequest: @NonNullRestoreFileRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<FileJobResponse>> abstract fun restore(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullparams: @NonNullRestoreFileParams): CompletableFuture<Response<FileJobResponse>> Restore a file from the deleted state.
restoreWithMinimalResponse	[JVM] abstract fun restoreWithMinimalResponse(@NonNullrequest: @NonNullRestoreFileRequest): CompletableFuture<Response<MinimalFileJobResponse>> abstract fun restoreWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID): CompletableFuture<Response<MinimalFileJobResponse>> Restore a file from the deleted state and returns minimal response. [JVM] abstract fun restoreWithMinimalResponse(@NonNullrequest: @NonNullRestoreFileRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<MinimalFileJobResponse>> abstract fun restoreWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullparams: @NonNullRestoreFileParams): CompletableFuture<Response<MinimalFileJobResponse>> Restore a file from the deleted state and return a minimal response.
unlock	[JVM] abstract fun unlock(@NonNullrequest: @NonNullUnlockFileRequest): CompletableFuture<Response<File>> Unlock a file
unlockWithMinimalResponse	[JVM] abstract fun unlockWithMinimalResponse(@NonNullrequest: @NonNullUnlockFileRequest): CompletableFuture<Response<MinimalFile>> Unlock a file and return a minimal response.
update	[JVM] abstract fun update(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullrequest: @NonNullUpdateFileRequest): CompletableFuture<Response<File>> abstract fun update(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullrequest: @NonNullUpdateFileRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<File>> Updates a file.
updateWithMinimalResponse	[JVM] abstract fun updateWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullrequest: @NonNullUpdateFileRequest): CompletableFuture<Response<MinimalFile>> abstract fun updateWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfileId: @NonNullUUID, @NonNullrequest: @NonNullUpdateFileRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<MinimalFile>> Updates a file and returns a minimal response.
upload	[JVM] abstract fun upload(@NonNullspaceId: @NonNullUUID, @NonNulluploadId: @NonNullUUID, @NonNullfile: @NonNullFile): CompletableFuture<Boolean> abstract fun upload(@NonNullspaceId: @NonNullUUID, @NonNulluploadId: @NonNullUUID, @NonNullfile: @NonNullFile, @NonNullconfiguration: @NonNullTransferFileConfiguration): CompletableFuture<Boolean> Upload a file to the given uploadId. [JVM] abstract fun upload(@NonNullspaceId: @NonNullUUID, @NonNulluploadId: @NonNullUUID, @NonNullmainFile: @NonNullFile, supportFileResources: List<SupportFileResourceUploadItem>): CompletableFuture<Boolean> abstract fun upload(@NonNullspaceId: @NonNullUUID, @NonNulluploadId: @NonNullUUID, @NonNullmainFile: @NonNullFile, supportFileResources: List<SupportFileResourceUploadItem>, @NonNullconfiguration: @NonNullTransferFileConfiguration): CompletableFuture<Boolean> Upload a file along with support files to the given package upload ID.
waitForUpload	[JVM] abstract fun waitForUpload(@NonNullspaceId: @NonNullUUID, @NonNulluploadId: @NonNullUUID, interval: Duration, timeout: Duration, callback: UploadStatusCallBack): CompletableFuture<Response<UploadDetails>> Poll the upload status by Id.