Skip to content

CopyBetweenOptions

Defined in: src/client/operations.ts:151

Options for copyBetween.

PropertyTypeDescriptionInherited fromDefined in
bandwidthLimit?TransferBandwidthLimitOptional bandwidth limit forwarded to the engine.RunRouteOptions.bandwidthLimitsrc/mft/runRoute.ts:52
clientTransferClientTransfer client used to resolve both endpoint providers.-src/client/operations.ts:153
destinationRemoteFileEndpointDestination remote endpoint.-src/client/operations.ts:157
engine?TransferEngineOptional transfer engine override. A fresh engine is created when omitted.RunRouteOptions.enginesrc/mft/runRoute.ts:38
jobId?stringOptional explicit job id. Defaults to a deterministic route-derived id.RunRouteOptions.jobIdsrc/mft/runRoute.ts:40
metadata?Record<string, unknown>Caller-defined metadata merged into the resulting transfer job.RunRouteOptions.metadatasrc/mft/runRoute.ts:54
now?() => DateOptional clock used to derive the default job id. Defaults to Date.now.RunRouteOptions.nowsrc/mft/runRoute.ts:42
onProgress?(event: TransferProgressEvent) => voidProgress observer forwarded to the engine.RunRouteOptions.onProgresssrc/mft/runRoute.ts:48
retry?TransferRetryPolicyRetry policy forwarded to the engine.RunRouteOptions.retrysrc/mft/runRoute.ts:46
routeId?stringStable route id assigned to the synthetic route. Defaults to "upload:...", "download:...", or "copy:...".FriendlyTransferOptions.routeIdsrc/client/operations.ts:30
routeName?stringOptional human-readable route name forwarded to telemetry.FriendlyTransferOptions.routeNamesrc/client/operations.ts:32
signal?AbortSignalAbort signal used to cancel the route execution.RunRouteOptions.signalsrc/mft/runRoute.ts:44
sourceRemoteFileEndpointSource remote endpoint.-src/client/operations.ts:155
timeout?TransferTimeoutPolicyTimeout policy forwarded to the engine.RunRouteOptions.timeoutsrc/mft/runRoute.ts:50