Skip to content

Overview

//trimblecloud-fileservice/trimblecloud.fileservice/ResourcesAPI

ResourcesAPI

[JVM]
interface ResourcesAPI

Represents retrieve operations that can be performed on a resource.

Functions

NameSummary
get[JVM]
abstract fun get(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString): CompletableFuture<Response<Resource>>
abstract fun get(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString, @NonNullparams: @NonNullGetResourceParams): CompletableFuture<Response<Resource>>
Get resource by path.
[JVM]
abstract fun get(@NonNullspaceId: @NonNullUUID, @NonNullresourceId: @NonNullUUID): CompletableFuture<Response<Resource>>
abstract fun get(@NonNullspaceId: @NonNullUUID, @NonNullresourceId: @NonNullUUID, @NonNullparams: @NonNullGetResourceParams): CompletableFuture<Response<Resource>>
Get resource by id.
getBatch[JVM]
abstract fun getBatch(@NonNullspaceId: @NonNullUUID, @NonNullrequest: @NonNullBatchResourceRequest): CompletableFuture<Response<ResourceBatch>>
Get resources in batch by specifying a list of IDs or paths.
[JVM]
abstract fun getBatch(@NonNullspaceId: @NonNullUUID, @NonNullrequest: @NonNullBatchResourceRequest, @NonNullparams: @NonNullGetResourceParams): CompletableFuture<Response<ResourceBatch>>
Get resources in batch by specifying a list of IDs or paths with additional parameters.
getBatchWithMinimalResponse[JVM]
abstract fun getBatchWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullrequest: @NonNullBatchResourceRequest): CompletableFuture<Response<MinimalResourceBatch>>
Get resources in batch with minimal response by specifying a list of IDs or paths.
[JVM]
abstract fun getBatchWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullrequest: @NonNullBatchResourceRequest, @NonNullparams: @NonNullGetResourceParams): CompletableFuture<Response<MinimalResourceBatch>>
Get resources in batch with minimal response by specifying a list of IDs or paths with additional parameters.
getWithMinimalResponse[JVM]
abstract fun getWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString): CompletableFuture<Response<MinimalResource>>
abstract fun getWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullpath: @NonNullString, @NonNullparams: @NonNullGetResourceParams): CompletableFuture<Response<MinimalResource>>
Get minimal resource by path.
[JVM]
abstract fun getWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullresourceId: @NonNullUUID): CompletableFuture<Response<MinimalResource>>
abstract fun getWithMinimalResponse(@NonNullspaceId: @NonNullUUID, @NonNullresourceId: @NonNullUUID, @NonNullparams: @NonNullGetResourceParams): CompletableFuture<Response<MinimalResource>>
Get minimal resource by id.