Skip to content

Overview

//trimblecloud-fileservice/trimblecloud.fileservice.models/CreateSupportFileUploadRequest

CreateSupportFileUploadRequest

[JVM]
open class CreateSupportFileUploadRequest

Represents a request to create a support file upload.

Types

NameSummary
CreateSupportFileUploadRequestBuilder[JVM]
open class CreateSupportFileUploadRequestBuilder

Properties

NameSummary
addToLinks[JVM]
open val addToLinks: Boolean
Whether the support file should be linked to the parent file Default: true
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.
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 support file.
parentId[JVM]
@NonNull
@get:NonNull
open val parentId: @NonNullUUID
Parent file identifier to which the support file has to be uploaded.
parentMajorVersion[JVM]
open val parentMajorVersion: Integer
The major version of the file
parentType[JVM]
val parentType: ParentType
The type of the parent
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.
supportFileKey[JVM]
open val supportFileKey: String
The key of the support file
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

NameSummary
builder[JVM]
open fun builder(): CreateSupportFileUploadRequest.CreateSupportFileUploadRequestBuilder
isMultipart[JVM]
open fun isMultipart(): Boolean
True if the client will split the upload into multiple parts.
toString[JVM]
open fun toString(): String