Skip to content

Overview

//trimblecloud-fileservice/trimblecloud.fileservice.models

Package-level declarations

Types

NameSummary
Acl[JVM]
open class Acl
Represents the actor role mapping for the resources.
AclActor[JVM]
open class AclActor
Represents the actor role mapping for the resources.
AclApplicationIdentity[JVM]
open class AclApplicationIdentity : AclIdentity
Represents an application identity in the access control list (ACL).
AclCustomIdentity[JVM]
open class AclCustomIdentity : AclIdentity
Represents a custom identity in the access control list (ACL).
AclDeviceIdentity[JVM]
open class AclDeviceIdentity : AclIdentity
Represents an application identity in the access control list (ACL).
AclIdentity[JVM]
abstract class AclIdentity
Represents an identity in the access control list (ACL).
AclIdentityDeserializer[JVM]
open class AclIdentityDeserializer : JsonDeserializer<T>
AclIdentitySerializer[JVM]
open class AclIdentitySerializer : JsonSerializer<T>
AclRole[JVM]
enum AclRole
Represents the roles that can be assigned to an actor in the file space.
AclUserIdentity[JVM]
open class AclUserIdentity : AclIdentity
Represents an application identity in the access control list (ACL).
BatchResourceRequest[JVM]
open class BatchResourceRequest
Represents a request to retrieve multiple resources in a batch.
Capabilities[JVM]
open class Capabilities
Represents actions that can be performed on the resource by a user.
CheckinFileRequest[JVM]
open class CheckinFileRequest
Represents a request to checkin a file.
CheckinFolderRequest[JVM]
open class CheckinFolderRequest
Represents a request to checkin a folder.
Checkout[JVM]
open class Checkout
Checkout attached to the file.
CheckoutFileRequest[JVM]
open class CheckoutFileRequest
Represents a request to checkout a file.
CheckoutFolderRequest[JVM]
open class CheckoutFolderRequest
Represents a request to checkout a folder.
CopyFileParams[JVM]
open class CopyFileParams
Represents the parameters for the file copy operation.
CopyFileRequest[JVM]
open class CopyFileRequest
Represents a request to copy a file.
CopyFolderParams[JVM]
open class CopyFolderParams
Represents the parameters for the folder copy operation.
CopyFolderRequest[JVM]
open class CopyFolderRequest
Represents the request to copy a folder.
CreateBatchFolderChildren[JVM]
open class CreateBatchFolderChildren
Represents a folder in a batch create request.
CreateBatchFolderRequest[JVM]
open class CreateBatchFolderRequest
Represents a batch folder creation request that contains a list of folders to create.
CreateCompleteMultipartRequest[JVM]
open class CreateCompleteMultipartRequest
Represents a multipart request.
CreateExportRequest[JVM]
open class CreateExportRequest
Represents a request to create an export.
CreateFileUploadRequest[JVM]
open class CreateFileUploadRequest
Represents a request to create a file upload.
CreateFolderRequest[JVM]
open class CreateFolderRequest
Represents a request to create a folder.
CreateNestedFolderChildren[JVM]
open class CreateNestedFolderChildren
Represents a nested folder child in a batch create request.
CreatePackageUploadRequest[JVM]
open class CreatePackageUploadRequest
Represents a request to create a package upload.
CreateSpaceRequest[JVM]
open class CreateSpaceRequest
Represents a request to create a space.
CreateSupportFileUploadRequest[JVM]
open class CreateSupportFileUploadRequest
Represents a request to create a support file upload.
DeleteFileRequest[JVM]
open class DeleteFileRequest
Represents a request to delete a file.
DeleteFolderParams[JVM]
open class DeleteFolderParams
Represents parameters for deleting a folder.
DeleteFolderRequest[JVM]
open class DeleteFolderRequest
Represents a request to delete a folder.
DeleteSpaceParams[JVM]
open class DeleteSpaceParams
Represents parameters for deleting a space.
Download[JVM]
open class Download
Represents a download.
Export[JVM]
open class Export
Represents an export.
ExportInfo[JVM]
open class ExportInfo
Represents the response of creating an export.
ExportStatus[JVM]
enum ExportStatus
The status of the export operation.
File[JVM]
open class File
Represents a file response.
FileAcl[JVM]
open class FileAcl
Represents the actor role mapping for the resources.
FileAndFolderList[JVM]
open class FileAndFolderList
Represents the response for the file/folder list operation.
FileInputUploadDetails[JVM]
open class FileInputUploadDetails
The file input upload details.
FileJobResponse[JVM]
open class FileJobResponse
Represents a response for file asynchronous operations.
FileList[JVM]
open class FileList
Represents a response containing a list of files.
FilePermissionsLocal[JVM]
open class FilePermissionsLocal
Represents the permissions explicitly assigned to a file.
FileStatistics[JVM]
open class FileStatistics
Represents the statistics of a file.
FileStatus[JVM]
enum FileStatus
The status of the file upload.
Folder[JVM]
open class Folder
Represents a folder.
FolderBatch[JVM]
open class FolderBatch
Represents the response for batch folder creation operation.
FolderJobResponse[JVM]
open class FolderJobResponse
Represents the response of folder asynchronous operations.
FolderList[JVM]
open class FolderList
Represents a response containing a list of folders.
FolderPermissionsLocal[JVM]
open class FolderPermissionsLocal
Represents the permissions explicitly assigned to a folder.
FolderStatistics[JVM]
open class FolderStatistics
Represents the statistics of a folder.
GetFileParams[JVM]
open class GetFileParams
Represents the parameters that can be used to filter the files returned by the get operation.
GetJobParams[JVM]
open class GetJobParams
Represents the parameters that can be used to filter the job details.
GetResourceParams[JVM]
open class GetResourceParams
Represents the parameters that can be used to filter the resources
GetUploadDetailsParams[JVM]
open class GetUploadDetailsParams
Represents the parameters that can be used to filter the upload details returned by the get operation.
InheritedAcl[JVM]
open class InheritedAcl
Represents the actor role mapping for the resources that are inherited.
InvalidFolder[JVM]
open class InvalidFolder
Represents invalid items that could not be retrieved, along with the reason for their invalidity.
InvalidResource[JVM]
open class InvalidResource
Represents invalid items that could not be retrieved, along with the reason for their invalidity.
Job[JVM]
open class Job
Represents a Job Response.
JobInfo[JVM]
open class JobInfo
Represents the response for deleting an entity.
JobStatus[JVM]
enum JobStatus
The status of the job
JobType[JVM]
enum JobType
The type of job to be executed.
ListChildrenResourceType[JVM]
enum ListChildrenResourceType
Represents the resource types that can be used to filter children resources in list operations.
ListFileParams[JVM]
open class ListFileParams
Represents the parameters to filter the file list operation.
ListFolderChildrenParams[JVM]
open class ListFolderChildrenParams
Represents the parameters for folder children list operation.
ListFolderParams[JVM]
open class ListFolderParams
Represents the query parameters for the folder list operation.
ListManifestParams[JVM]
open class ListManifestParams
Represents the parameters to filter the file list operation.
ListPublicResourcesParams[JVM]
open class ListPublicResourcesParams
Represents the parameters for listing public resources with anonymous access in a space.
ListSpaceChildrenParams[JVM]
open class ListSpaceChildrenParams
Represents the parameters for space children list operation.
Lock[JVM]
open class Lock
Represents lock details for a file.
LockFileRequest[JVM]
open class LockFileRequest
Represents a request to lock a file.
MalwareScanStatus[JVM]
enum MalwareScanStatus
The malware scan status of a file Possible values are ‘CLEAN’, ‘INFECTED’, ‘SCANNING’, or ‘FAILED’.
ManifestFile[JVM]
open class ManifestFile
Represents single file inside a fileset
ManifestFileList[JVM]
open class ManifestFileList
Represents a response containing a list of files.
MinimalFile[JVM]
open class MinimalFile
Represents a file response.
MinimalFileAndFolderList[JVM]
open class MinimalFileAndFolderList
Represents the response for the file/folder list operation with minimal information.
MinimalFileJobResponse[JVM]
open class MinimalFileJobResponse
Represents a response for file asynchronous operations.
MinimalFileList[JVM]
open class MinimalFileList
Represents a response containing a list of files with minimal information.
MinimalFolder[JVM]
open class MinimalFolder
Represents a folder with minimal information.
MinimalFolderBatch[JVM]
open class MinimalFolderBatch
Represents the response for batch folder creation operation.
MinimalFolderJobResponse[JVM]
open class MinimalFolderJobResponse
Represents the response of minimal folder asynchronous operations.
MinimalFolderList[JVM]
open class MinimalFolderList
Represents a response containing a list of folders with minimal information.
MinimalResource[JVM]
open class MinimalResource
MinimalResourceBatch[JVM]
open class MinimalResourceBatch
Represents the response for the file/folder list operation.
MinimalSpace[JVM]
open class MinimalSpace
Represents a space response with minimal information.
MinimalSpaceList[JVM]
open class MinimalSpaceList
Represents the response for the file/folder list operation.
MoveFileRequest[JVM]
open class MoveFileRequest
Represents a request to move a file.
MoveFolderRequest[JVM]
open class MoveFolderRequest
Output[JVM]
open class Output
Represents an output of an export.
ParentType[JVM]
enum ParentType
The parent type of a file or folder.
PartETag[JVM]
open class PartETag
Represents a part ETag.
PermissionsEvaluated[JVM]
open class PermissionsEvaluated
Represents the permissions evaluated for the actors on the resource.
PermissionsInherited[JVM]
open class PermissionsInherited
Represents the permissions inherited from the entire parent hierarchy applicable for the actor.
Provider[JVM]
enum Provider
The cloud provider where the space will be created.
RenameFileRequest[JVM]
open class RenameFileRequest
Represents a request to rename a file.
RenameFolderRequest[JVM]
open class RenameFolderRequest
Represents a request to rename a folder.
RequestHeader[JVM]
open class RequestHeader
Enables optimistic concurrency control by validating the resource’s current state.
Resource[JVM]
open class Resource
ResourceBatch[JVM]
open class ResourceBatch
Represents the response for the file/folder list operation.
ResourceType[JVM]
enum ResourceType
Response[JVM]
open class Response
Optional response attributes used during creation.
RestoreFileParams[JVM]
open class RestoreFileParams
Represents parameters to restore a file.
RestoreFileRequest[JVM]
open class RestoreFileRequest
Represents a request to restore a file.
RestoreFolderParams[JVM]
open class RestoreFolderParams
Represents parameters to restore a folder.
RestoreFolderRequest[JVM]
open class RestoreFolderRequest
Represents a request to restore a folder.
RestoreMinimalSpace[JVM]
open class RestoreMinimalSpace
Represents the response for restoring a space and returns a minimal response.
RestoreSpace[JVM]
open class RestoreSpace
Represents the response for restoring a space.
Result[JVM]
open class Result
Represents the result of an upload operation.
SoftDeleteRetentionPeriod[JVM]
enum SoftDeleteRetentionPeriod
Represents the retention period for soft deleted resources in a filespace.
Space[JVM]
open class Space
Represents a space response.
SpaceList[JVM]
open class SpaceList
Represents the response for the file/folder list operation.
SpaceMembershipBoundary[JVM]
open class SpaceMembershipBoundary
Space membership boundary settings that allow space managers to restrict content access to space members
SpacePermissionsLocal[JVM]
open class SpacePermissionsLocal
Represents the permissions explicitly assigned to a space.
SpaceStatistics[JVM]
open class SpaceStatistics
Represents the statistics of a space.
Status[JVM]
enum Status
The status query parameter is used to filter the resources based on their status.
SupportFileDetails[JVM]
open class SupportFileDetails
Support file link details.
SupportFileLinkRequest[JVM]
open class SupportFileLinkRequest
Represents attributes of a file that can be updated.
SupportFileResource[JVM]
open class SupportFileResource
Represents a support file resource.
SupportFileResourceDetails[JVM]
open class SupportFileResourceDetails
Represents the details of a support file.
SupportFileResourceUploadItem[JVM]
open class SupportFileResourceUploadItem
Represents a support file resource for uploading.
UnlockFileRequest[JVM]
open class UnlockFileRequest
Represents a request to unlock a file.
UpdateFileAcl[JVM]
open class UpdateFileAcl
Represents a request to update space ACL.
UpdateFilePermissionsLocal[JVM]
open class UpdateFilePermissionsLocal
Represents a file permissions update request.
UpdateFileRequest[JVM]
open class UpdateFileRequest
Represents a request to update a file.
UpdateFolderAcl[JVM]
open class UpdateFolderAcl
Represents a request to update space ACL.
UpdateFolderPermissionsLocal[JVM]
open class UpdateFolderPermissionsLocal
Represents a folder permissions update request.
UpdateFolderRequest[JVM]
open class UpdateFolderRequest
Represents a request to update a folder.
UpdateSpaceAcl[JVM]
open class UpdateSpaceAcl
Represents a request to update space ACL.
UpdateSpacePermissionsLocal[JVM]
open class UpdateSpacePermissionsLocal
Represents a space permissions update request.
UpdateSpaceRequest[JVM]
open class UpdateSpaceRequest
Represents a request to update a space.
UpdateSupportFileDetails[JVM]
open class UpdateSupportFileDetails
Represents a request to update a support file.
Upload[JVM]
open class Upload
The upload object.
UploadDetails[JVM]
open class UploadDetails
Represents the details of an upload.
UploadStatus[JVM]
enum UploadStatus
The status of the upload operation.
UploadType[JVM]
enum UploadType
Represents the type of upload.