Skip to content

TransferReceipt

Defined in: src/transfers/TransferJob.ts:123

Audit-friendly receipt for a completed transfer job.

PropertyTypeDescriptionDefined in
attemptsTransferAttempt[]Attempt history, including retry failures.src/transfers/TransferJob.ts:155
averageBytesPerSecondnumberAverage throughput in bytes per second.src/transfers/TransferJob.ts:145
bytesTransferrednumberTotal bytes transferred by the successful operation.src/transfers/TransferJob.ts:135
checksum?stringOptional checksum value produced or verified by the operation.src/transfers/TransferJob.ts:153
completedAtDateTime the successful attempt completed.src/transfers/TransferJob.ts:141
destination?TransferEndpointDestination endpoint when supplied by the job.src/transfers/TransferJob.ts:133
durationMsnumberTotal elapsed time in milliseconds.src/transfers/TransferJob.ts:143
jobIdstringOriginal job identifier.src/transfers/TransferJob.ts:127
metadata?Record<string, unknown>Caller-defined metadata retained from the job.src/transfers/TransferJob.ts:159
operationTransferOperationOperation performed by the job.src/transfers/TransferJob.ts:129
resumedbooleanWhether the transfer resumed prior partial work.src/transfers/TransferJob.ts:147
source?TransferEndpointSource endpoint when supplied by the job.src/transfers/TransferJob.ts:131
startedAtDateTime the first attempt began.src/transfers/TransferJob.ts:139
totalBytes?numberExpected total bytes when known.src/transfers/TransferJob.ts:137
transferIdstringStable transfer identifier used for progress and log correlation.src/transfers/TransferJob.ts:125
verification?TransferVerificationResultNormalized post-transfer verification details when supplied by the operation.src/transfers/TransferJob.ts:151
verifiedbooleanWhether post-transfer verification completed successfully.src/transfers/TransferJob.ts:149
warningsstring[]Non-fatal warnings produced during execution.src/transfers/TransferJob.ts:157