Overview

//trimblecloud-fileservice/trimblecloud.fileservice/SpacesAPI

SpacesAPI

[JVM]
interface SpacesAPI

Represents all operations that can be performed on a space.

Functions

Name	Summary
create	[JVM] abstract fun create(@NonNullrequest: @NonNullCreateSpaceRequest): CompletableFuture<Response<Space>> Creates a space.
createWithMinimalResponse	[JVM] abstract fun createWithMinimalResponse(@NonNullrequest: @NonNullCreateSpaceRequest): CompletableFuture<Response<MinimalSpace>> Creates a space and returns a minimal response.
delete	[JVM] abstract fun delete(@NonNullspaceId: @NonNullUUID): CompletableFuture<Response<JobInfo>> Delete an empty space by Id. [JVM] abstract fun delete(@NonNullspaceId: @NonNullUUID, @NonNullparams: @NonNullDeleteSpaceParams): CompletableFuture<Response<JobInfo>> Delete a non empty space by Id.
get	[JVM] abstract fun get(@NonNullspaceId: @NonNullUUID): CompletableFuture<Response<Space>> Get space by Id. [JVM] abstract fun get(@NonNullspaceId: @NonNullUUID, status: Status): CompletableFuture<Response<Space>> Get space descriptor by Id.
getWithMinimalResponse	[JVM] abstract fun getWithMinimalResponse(@NonNullspaceId: @NonNullUUID): CompletableFuture<Response<MinimalSpace>> abstract fun getWithMinimalResponse(@NonNullspaceId: @NonNullUUID, status: Status): CompletableFuture<Response<MinimalSpace>> Get minimal space by Id.
listChildren	[JVM] abstract fun listChildren(@NonNullspaceId: @NonNullUUID): CompletableFuture<Response<SpaceList>> abstract fun listChildren(@NonNullspaceId: @NonNullUUID, @NonNullparams: @NonNullListSpaceChildrenParams): CompletableFuture<Response<SpaceList>> Lists all children of a space by space identifier.
listChildrenWithMinimalResponse	[JVM] abstract fun listChildrenWithMinimalResponse(@NonNullspaceId: @NonNullUUID): CompletableFuture<Response<MinimalSpaceList>> abstract fun listChildrenWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullparams: @NonNullListSpaceChildrenParams): CompletableFuture<Response<MinimalSpaceList>> Lists all children of a space by space identifier with minimal details.
listPublicResources	[JVM] abstract fun listPublicResources(@NonNullspaceId: @NonNullUUID): CompletableFuture<Response<MinimalSpaceList>> abstract fun listPublicResources(@NonNullspaceId: @NonNullUUID, @NonNullparams: @NonNullListPublicResourcesParams): CompletableFuture<Response<MinimalSpaceList>> Lists all resources with anonymous access within a space.
restore	[JVM] abstract fun restore(@NonNullspaceId: @NonNullUUID): CompletableFuture<Response<RestoreSpace>> Restores a space.
restoreWithMinimalResponse	[JVM] abstract fun restoreWithMinimalResponse(@NonNullspaceId: @NonNullUUID): CompletableFuture<Response<RestoreMinimalSpace>> Restores a space and returns a minimal response.
update	[JVM] abstract fun update(@NonNullspaceId: @NonNullUUID, @NonNullrequest: @NonNullUpdateSpaceRequest): CompletableFuture<Response<Space>> Update space by Id.
updateWithMinimalResponse	[JVM] abstract fun updateWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullrequest: @NonNullUpdateSpaceRequest): CompletableFuture<Response<MinimalSpace>> Update space by Id and return a minimal response.