Share via

CopyProperties Class

  • Reference

File Copy Properties.

Inheritance
builtins.object
CopyProperties

Constructor

CopyProperties()

Variables

Name Description
id
str

String identifier for the last attempted Copy File operation where this file was the destination file. This header does not appear if this file has never been the destination in a Copy File operation, or if this file has been modified after a concluded Copy File operation using Set File Properties or Put File.
source
str

URL up to 2 KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file. This header does not appear if this file has never been the destination in a Copy File operation, or if this file has been modified after a concluded Copy File operation using Set File Properties or Put File.
status
str

State of the copy operation identified by Copy ID, with these values: success: Copy completed successfully.

pending: Copy is in progress. Check copy_status_description if intermittent, non-fatal errors impede copy progress but don't cause failure.

aborted: Copy was ended by Abort Copy File.

failed: Copy failed. See copy_status_description for failure details.
progress
str

Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied.
completion_time
datetime

Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt.
status_description
str

Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure.