Overview
//trimblecloud-fileservice/trimblecloud.fileservice.models/CreateFileUploadRequest
CreateFileUploadRequest
[JVM]
open class CreateFileUploadRequest
Represents a request to create a file upload.
Types
| Name | Summary |
|---|---|
| CreateFileUploadRequestBuilder | [JVM] open class CreateFileUploadRequestBuilder |
Properties
| Name | Summary |
|---|---|
| expiresAt | [JVM] open val expiresAt: Date Time period when the file object gets automatically removed. |
| fileset | [JVM] open val fileset: Boolean Whether the object consists of a set of multiple files that should be treated as a single file, such as with shape files. |
| includeLinks | [JVM] open val includeLinks: Boolean Whether to include the links from the last version during a parent file’s major version change. |
| metadata | [JVM] open val metadata: HashMap<String, Any> Clients may set additional information related to the file here. |
| name | [JVM] @NonNull @get:NonNull open val name: @NonNullString The name of the file. |
| parentId | [JVM] @NonNull @get:NonNull open val parentId: @NonNullUUID Parent folder identifier to which the file has to be uploaded. |
| parentType | [JVM] val parentType: ParentType The type of the parent |
| permissionsLocal | [JVM] open val permissionsLocal: FilePermissionsLocal The permissions explicitly assigned to the file. |
| responseHeaders | [JVM] open val responseHeaders: HashMap<String, String> Download HTTP response headers can be set here. |
| restrictedAccess | [JVM] open val restrictedAccess: Boolean Set to false if the download url of the file shouldn’t be expired. |
| urlDuration | [JVM] open val urlDuration: String The file upload URL’s validity duration can be set in days (d), hours (h), or minutes (m). |
Functions
| Name | Summary |
|---|---|
| builder | [JVM] open fun builder(): CreateFileUploadRequest.CreateFileUploadRequestBuilder |
| isMultipart | [JVM] open fun isMultipart(): Boolean True if the client will split the upload into multiple parts. |
| toString | [JVM] open fun toString(): String |