/
azure.storage.blob.CopyProperties.yml
112 lines (97 loc) · 3.37 KB
/
azure.storage.blob.CopyProperties.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
### YamlMime:PythonClass
uid: azure.storage.blob.CopyProperties
name: CopyProperties
fullName: azure.storage.blob.CopyProperties
module: azure.storage.blob
inheritances:
- azure.storage.blob._shared.models.DictMixin
summary: 'Blob Copy Properties.
These properties will be *None* if this blob has never been the destination
in a Copy Blob operation, or if this blob has been modified after a concluded
Copy Blob operation, for example, using Set Blob Properties, Upload Blob, or Commit
Block List.'
constructor:
syntax: CopyProperties(**kwargs)
variables:
- description: 'String identifier for the last attempted Copy Blob operation where
this blob
was the destination blob.'
name: id
types:
- <xref:str>
- description: 'URL up to 2 KB in length that specifies the source blob used in the
last attempted
Copy Blob operation where this blob was the destination blob.'
name: source
types:
- <xref:str>
- description: "State of the copy operation identified by Copy ID, with these values:\n\
\ success:\n Copy completed successfully.\n\n pending:\n Copy is\
\ in progress. Check copy_status_description if intermittent,\n non-fatal\
\ errors impede copy progress but don't cause failure.\n\n aborted:\n Copy\
\ was ended by Abort Copy Blob.\n\n failed:\n Copy failed. See copy_status_description\
\ for failure details."
name: status
types:
- <xref:str>
- description: 'Contains the number of bytes copied and the total bytes in the source
in the last
attempted Copy Blob operation where this blob was the destination blob. Can show
between 0 and Content-Length bytes copied.'
name: progress
types:
- <xref:str>
- description: 'Conclusion time of the last attempted Copy Blob operation where this
blob was the
destination blob. This value can specify the time of a completed, aborted, or
failed copy attempt.'
name: completion_time
types:
- <xref:datetime.datetime>
- description: 'Only appears when x-ms-copy-status is failed or pending. Describes
cause of fatal
or non-fatal copy operation failure.'
name: status_description
types:
- <xref:str>
- description: 'Copies the snapshot of the source page blob to a destination page
blob.
The snapshot is copied such that only the differential changes between
the previously copied snapshot are transferred to the destination'
name: incremental_copy
types:
- <xref:bool>
- description: 'Included if the blob is incremental copy blob or incremental copy
snapshot,
if x-ms-copy-status is success. Snapshot time of the last successful
incremental copy snapshot for this blob.'
name: destination_snapshot
types:
- <xref:datetime.datetime>
methods:
- uid: azure.storage.blob.CopyProperties.get
name: get
signature: get(key, default=None)
parameters:
- name: key
isRequired: true
- name: default
defaultValue: None
- uid: azure.storage.blob.CopyProperties.has_key
name: has_key
signature: has_key(k)
parameters:
- name: k
isRequired: true
- uid: azure.storage.blob.CopyProperties.items
name: items
signature: items()
- uid: azure.storage.blob.CopyProperties.keys
name: keys
signature: keys()
- uid: azure.storage.blob.CopyProperties.update
name: update
signature: update(*args, **kwargs)
- uid: azure.storage.blob.CopyProperties.values
name: values
signature: values()