Skip to content

Overview

//trimblecloud-fileservice/trimblecloud.fileservice.models/CopyFileRequest

CopyFileRequest

[JVM]
open class CopyFileRequest

Represents a request to copy a file. To copy a specific version of a file, use versionId.

Types

NameSummary
CopyFileRequestBuilder[JVM]
open class CopyFileRequestBuilder

Properties

NameSummary
fileId[JVM]
@NonNull
@get:NonNull
open val fileId: @NonNullUUID
File identifier.
name[JVM]
open val name: String
Optionally provide a new name for the copied file.
permissionsLocal[JVM]
open val permissionsLocal: FilePermissionsLocal
The permissions explicitly assigned to the file.
spaceId[JVM]
@NonNull
@get:NonNull
open val spaceId: @NonNullUUID
Space identifier.
targetParentId[JVM]
@NonNull
@get:NonNull
open val targetParentId: @NonNullUUID
The target parent id.
version[JVM]
open val version: String
Version identifier of the file to be copied.

Functions

NameSummary
builder[JVM]
open fun builder(): CopyFileRequest.CopyFileRequestBuilder
getQueryParameters[JVM]
open fun getQueryParameters(): Map<String, String>
Get the query parameters.
isIncludeAcl[JVM]
open fun isIncludeAcl(): Boolean
Whether to copy the ACL from the resource to the target resource.
isIncludeLinks[JVM]
open fun isIncludeLinks(): Boolean
Whether to include support file links in the copy operation.
isIncludeSupportFiles[JVM]
open fun isIncludeSupportFiles(): Boolean
Whether to include support files in the copy operation.
isOverwriteExisting[JVM]
open fun isOverwriteExisting(): Boolean
Whether to overwrite an existing resource.
toString[JVM]
open fun toString(): String