Overview

//trimblecloud-fileservice/trimblecloud.fileservice/FoldersAPI

FoldersAPI

[JVM]
interface FoldersAPI

Represents all operations that can be performed on a folder.

Functions

Name	Summary
checkin	[JVM] abstract fun checkin(@NonNullrequest: @NonNullCheckinFolderRequest): CompletableFuture<Response<Folder>> Checking in a folder will release the checkout and allow other actors to create new versions or perform other mutation operations.
checkinWithMinimalResponse	[JVM] abstract fun checkinWithMinimalResponse(@NonNullrequest: @NonNullCheckinFolderRequest): CompletableFuture<Response<MinimalFolder>> Checking in a folder will release the checkout and allow other actors to create new versions or perform other mutation operations.
checkout	[JVM] abstract fun checkout(@NonNullrequest: @NonNullCheckoutFolderRequest): CompletableFuture<Response<Folder>> abstract fun checkout(@NonNullrequest: @NonNullCheckoutFolderRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<Folder>> Checking out a folder will prevent other actors from creating a new version or other mutation operations.
checkoutWithMinimalResponse	[JVM] abstract fun checkoutWithMinimalResponse(@NonNullrequest: @NonNullCheckoutFolderRequest): CompletableFuture<Response<MinimalFolder>> abstract fun checkoutWithMinimalResponse(@NonNullrequest: @NonNullCheckoutFolderRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<MinimalFolder>> Checking out a folder will prevent other actors from creating a new version or other mutation operations.
copy	[JVM] abstract fun copy(@NonNullrequest: @NonNullCopyFolderRequest): CompletableFuture<Response<FolderJobResponse>> abstract fun copy(@NonNullrequest: @NonNullCopyFolderRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<FolderJobResponse>> abstract fun copy(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNulltargetParentId: @NonNullUUID): CompletableFuture<Response<FolderJobResponse>> abstract fun copy(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNulltargetParentId: @NonNullUUID, @NonNullparams: @NonNullCopyFolderParams): CompletableFuture<Response<FolderJobResponse>> Copy a folder to a new location within the same space.
copyWithMinimalResponse	[JVM] abstract fun copyWithMinimalResponse(@NonNullrequest: @NonNullCopyFolderRequest): CompletableFuture<Response<MinimalFolderJobResponse>> abstract fun copyWithMinimalResponse(@NonNullrequest: @NonNullCopyFolderRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<MinimalFolderJobResponse>> abstract fun copyWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNulltargetParentId: @NonNullUUID): CompletableFuture<Response<MinimalFolderJobResponse>> abstract fun copyWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNulltargetParentId: @NonNullUUID, @NonNullparams: @NonNullCopyFolderParams): CompletableFuture<Response<MinimalFolderJobResponse>> Copy a folder to a new location within the same space and returns a minimal response.
create	[JVM] abstract fun create(@NonNullspaceId: @NonNullUUID, @NonNullrequest: @NonNullCreateFolderRequest): CompletableFuture<Response<Folder>> Creates a folder.
createBatch	[JVM] abstract fun createBatch(@NonNullrequest: @NonNullCreateBatchFolderRequest): CompletableFuture<Response<FolderBatch>> Creates multiple folders in a specified space by providing a list of create folder request bodies.
createBatchWithMinimalResponse	[JVM] abstract fun createBatchWithMinimalResponse(@NonNullrequest: @NonNullCreateBatchFolderRequest): CompletableFuture<Response<MinimalFolderBatch>> Creates multiple folders in a specified space by providing a list of create folder request bodies with minimal response.
createWithMinimalResponse	[JVM] abstract fun createWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullrequest: @NonNullCreateFolderRequest): CompletableFuture<Response<MinimalFolder>> Creates a folder and returns a minimal response.
delete	[JVM] abstract fun delete(@NonNullrequest: @NonNullDeleteFolderRequest): CompletableFuture<Response<JobInfo>> abstract fun delete(@NonNullrequest: @NonNullDeleteFolderRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<JobInfo>> abstract fun delete(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNullparams: @NonNullDeleteFolderParams): CompletableFuture<Response<JobInfo>> Deletes a folder by Id. [JVM] abstract fun delete(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID): CompletableFuture<Response<JobInfo>> Deletes an empty folder by Id.
get	[JVM] abstract fun get(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString): CompletableFuture<Response<Folder>> abstract fun get(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString, @NonNullstatus: @NonNullStatus): CompletableFuture<Response<Folder>> Retrieves a folder by path. [JVM] abstract fun get(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID): CompletableFuture<Response<Folder>> abstract fun get(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNullstatus: @NonNullStatus): CompletableFuture<Response<Folder>> Retrieves a folder by ID.
getVersion	[JVM] abstract fun getVersion(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString, @NonNullversion: @NonNullString): CompletableFuture<Response<Folder>> abstract fun getVersion(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString, @NonNullversion: @NonNullString, @NonNullstatus: @NonNullStatus): CompletableFuture<Response<Folder>> Get a specific version of a folder by path. [JVM] abstract fun getVersion(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNullversion: @NonNullString): CompletableFuture<Response<Folder>> abstract fun getVersion(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNullversion: @NonNullString, @NonNullstatus: @NonNullStatus): CompletableFuture<Response<Folder>> Get a specific version of a folder by ID.
getVersionWithMinimalResponse	[JVM] abstract fun getVersionWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString, @NonNullversion: @NonNullString): CompletableFuture<Response<MinimalFolder>> abstract fun getVersionWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString, @NonNullversion: @NonNullString, @NonNullstatus: @NonNullStatus): CompletableFuture<Response<MinimalFolder>> Get a specific version of a folder by path with minimal details. [JVM] abstract fun getVersionWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNullversion: @NonNullString): CompletableFuture<Response<MinimalFolder>> abstract fun getVersionWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNullversion: @NonNullString, @NonNullstatus: @NonNullStatus): CompletableFuture<Response<MinimalFolder>> Get a specific version of a folder by ID with minimal details.
getWithMinimalResponse	[JVM] abstract fun getWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString): CompletableFuture<Response<MinimalFolder>> abstract fun getWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString, @NonNullstatus: @NonNullStatus): CompletableFuture<Response<MinimalFolder>> Retrieves a folder by path with minimal details. [JVM] abstract fun getWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID): CompletableFuture<Response<MinimalFolder>> abstract fun getWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNullstatus: @NonNullStatus): CompletableFuture<Response<MinimalFolder>> Retrieves a folder by ID with minimal details.
listChildren	[JVM] abstract fun listChildren(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString): CompletableFuture<Response<FileAndFolderList>> abstract fun listChildren(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString, @NonNullparams: @NonNullListFolderChildrenParams): CompletableFuture<Response<FileAndFolderList>> Lists all children of a folder in a space by path. [JVM] abstract fun listChildren(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID): CompletableFuture<Response<FileAndFolderList>> abstract fun listChildren(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNullparams: @NonNullListFolderChildrenParams): CompletableFuture<Response<FileAndFolderList>> Lists all children of a folder in a space by folder identifier.
listChildrenWithMinimalResponse	[JVM] abstract fun listChildrenWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString): CompletableFuture<Response<MinimalFileAndFolderList>> abstract fun listChildrenWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString, @NonNullparams: @NonNullListFolderChildrenParams): CompletableFuture<Response<MinimalFileAndFolderList>> Lists all children of a folder in a space by path with minimal details. [JVM] abstract fun listChildrenWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID): CompletableFuture<Response<MinimalFileAndFolderList>> abstract fun listChildrenWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNullparams: @NonNullListFolderChildrenParams): CompletableFuture<Response<MinimalFileAndFolderList>> Lists all children of a folder in a space by folder identifier with minimal details.
listVersions	[JVM] abstract fun listVersions(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString): CompletableFuture<Response<FolderList>> abstract fun listVersions(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString, @NonNullparams: @NonNullListFolderParams): CompletableFuture<Response<FolderList>> List all versions for a folder in a space by path. [JVM] abstract fun listVersions(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID): CompletableFuture<Response<FolderList>> abstract fun listVersions(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNullparams: @NonNullListFolderParams): CompletableFuture<Response<FolderList>> List all versions for a folder in a space by folder identifier.
listVersionsWithMinimalResponse	[JVM] abstract fun listVersionsWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString): CompletableFuture<Response<MinimalFolderList>> abstract fun listVersionsWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString, @NonNullparams: @NonNullListFolderParams): CompletableFuture<Response<MinimalFolderList>> List all versions for a folder in a space by path with minimal details. [JVM] abstract fun listVersionsWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID): CompletableFuture<Response<MinimalFolderList>> abstract fun listVersionsWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNullparams: @NonNullListFolderParams): CompletableFuture<Response<MinimalFolderList>> List all versions for a folder in a space by folder identifier with minimal details.
move	[JVM] abstract fun move(@NonNullrequest: @NonNullMoveFolderRequest): CompletableFuture<Response<FolderJobResponse>> abstract fun move(@NonNullrequest: @NonNullMoveFolderRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<FolderJobResponse>> abstract fun move(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNulltargetParentId: @NonNullUUID): CompletableFuture<Response<FolderJobResponse>> Move a folder to a new location within the same space.
moveWithMinimalResponse	[JVM] abstract fun moveWithMinimalResponse(@NonNullrequest: @NonNullMoveFolderRequest): CompletableFuture<Response<MinimalFolderJobResponse>> abstract fun moveWithMinimalResponse(@NonNullrequest: @NonNullMoveFolderRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<MinimalFolderJobResponse>> abstract fun moveWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNulltargetParentId: @NonNullUUID): CompletableFuture<Response<MinimalFolderJobResponse>> Move a folder to a new location within the same space and returns a minimal response.
rename	[JVM] abstract fun rename(@NonNullrequest: @NonNullRenameFolderRequest): CompletableFuture<Response<FolderJobResponse>> abstract fun rename(@NonNullrequest: @NonNullRenameFolderRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<FolderJobResponse>> abstract fun rename(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNullname: @NonNullString): CompletableFuture<Response<FolderJobResponse>> Renames a folder.
renameWithMinimalResponse	[JVM] abstract fun renameWithMinimalResponse(@NonNullrequest: @NonNullRenameFolderRequest): CompletableFuture<Response<MinimalFolderJobResponse>> abstract fun renameWithMinimalResponse(@NonNullrequest: @NonNullRenameFolderRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<MinimalFolderJobResponse>> abstract fun renameWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNullname: @NonNullString): CompletableFuture<Response<MinimalFolderJobResponse>> Renames a folder and returns a minimal response.
restore	[JVM] abstract fun restore(@NonNullrequest: @NonNullRestoreFolderRequest): CompletableFuture<Response<FolderJobResponse>> abstract fun restore(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID): CompletableFuture<Response<FolderJobResponse>> abstract fun restore(@NonNullrequest: @NonNullRestoreFolderRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<FolderJobResponse>> Restores a folder to the original location. [JVM] abstract fun restore(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNullparams: @NonNullRestoreFolderParams): CompletableFuture<Response<FolderJobResponse>> Restores a folder to the location specified in the params.
restoreWithMinimalResponse	[JVM] abstract fun restoreWithMinimalResponse(@NonNullrequest: @NonNullRestoreFolderRequest): CompletableFuture<Response<MinimalFolderJobResponse>> abstract fun restoreWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID): CompletableFuture<Response<MinimalFolderJobResponse>> abstract fun restoreWithMinimalResponse(@NonNullrequest: @NonNullRestoreFolderRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<MinimalFolderJobResponse>> Restores a folder to the original location and returns a minimal response. [JVM] abstract fun restoreWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNullparams: @NonNullRestoreFolderParams): CompletableFuture<Response<MinimalFolderJobResponse>> Restores a folder to the location specified in the params and returns a minimal response.
update	[JVM] abstract fun update(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNullrequest: @NonNullUpdateFolderRequest): CompletableFuture<Response<Folder>> abstract fun update(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNullrequest: @NonNullUpdateFolderRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<Folder>> Updates a folder.
updateWithMinimalResponse	[JVM] abstract fun updateWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNullrequest: @NonNullUpdateFolderRequest): CompletableFuture<Response<MinimalFolder>> abstract fun updateWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullfolderId: @NonNullUUID, @NonNullrequest: @NonNullUpdateFolderRequest, @NonNullrequestHeader: @NonNullRequestHeader): CompletableFuture<Response<MinimalFolder>> Updates a folder and returns a minimal response.