-
Notifications
You must be signed in to change notification settings - Fork 181
/
BlobBeginCopyFromUrlPollState.yml
166 lines (162 loc) · 5.51 KB
/
BlobBeginCopyFromUrlPollState.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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
### YamlMime:TSType
name: BlobBeginCopyFromUrlPollState
uid: '@azure/storage-blob.BlobBeginCopyFromUrlPollState'
package: '@azure/storage-blob'
summary: >-
The state used by the poller returned from
[beginCopyFromURL](xref:@azure/storage-blob.BlobClient.beginCopyFromURL).
This state is passed into the user-specified `onProgress` callback
whenever copy progress is detected.
fullName: BlobBeginCopyFromUrlPollState
remarks: ''
isDeprecated: false
type: interface
properties:
- name: blobClient
uid: '@azure/storage-blob.BlobBeginCopyFromUrlPollState.blobClient'
package: '@azure/storage-blob'
summary: >-
The instance of [BlobClient](xref:@azure/storage-blob.BlobClient) that was
used when calling
[beginCopyFromURL](xref:@azure/storage-blob.BlobClient.beginCopyFromURL).
fullName: blobClient
remarks: ''
isDeprecated: false
syntax:
content: 'blobClient: CopyPollerBlobClient'
return:
description: ''
type: <xref uid="@azure/storage-blob.CopyPollerBlobClient" />
- name: copyId
uid: '@azure/storage-blob.BlobBeginCopyFromUrlPollState.copyId'
package: '@azure/storage-blob'
summary: The copyId that identifies the in-progress blob copy.
fullName: copyId
remarks: ''
isDeprecated: false
syntax:
content: 'copyId?: string'
return:
description: ''
type: string
- name: copyProgress
uid: '@azure/storage-blob.BlobBeginCopyFromUrlPollState.copyProgress'
package: '@azure/storage-blob'
summary: the progress of the blob copy as reported by the service.
fullName: copyProgress
remarks: ''
isDeprecated: false
syntax:
content: 'copyProgress?: string'
return:
description: ''
type: string
- name: copySource
uid: '@azure/storage-blob.BlobBeginCopyFromUrlPollState.copySource'
package: '@azure/storage-blob'
summary: >-
The source URL provided in
[beginCopyFromURL](xref:@azure/storage-blob.BlobClient.beginCopyFromURL).
fullName: copySource
remarks: ''
isDeprecated: false
syntax:
content: 'copySource: string'
return:
description: ''
type: string
- name: startCopyFromURLOptions
uid: '@azure/storage-blob.BlobBeginCopyFromUrlPollState.startCopyFromURLOptions'
package: '@azure/storage-blob'
summary: >-
The options that were passed to the initial
[beginCopyFromURL](xref:@azure/storage-blob.BlobClient.beginCopyFromURL)
call.
This is exposed for the poller and should not be modified directly.
fullName: startCopyFromURLOptions
remarks: ''
isDeprecated: false
syntax:
content: 'startCopyFromURLOptions?: BlobStartCopyFromURLOptions'
return:
description: ''
type: <xref uid="@azure/storage-blob.BlobStartCopyFromURLOptions" />
inheritedProperties:
- name: error
uid: '@azure/storage-blob.BlobBeginCopyFromUrlPollState.error'
package: '@azure/storage-blob'
summary: Will exist if the operation encountered any error.
fullName: error
remarks: ''
isDeprecated: false
syntax:
content: 'error?: Error'
return:
description: ''
type: Error
inheritanceDescription: >-
<b>Inherited From</b>
[PollOperationState.error](xref:@azure/storage-blob.PollOperationState.error)
- name: isCancelled
uid: '@azure/storage-blob.BlobBeginCopyFromUrlPollState.isCancelled'
package: '@azure/storage-blob'
summary: True if the operation has been cancelled.
fullName: isCancelled
remarks: ''
isDeprecated: false
syntax:
content: 'isCancelled?: boolean'
return:
description: ''
type: boolean
inheritanceDescription: >-
<b>Inherited From</b>
[PollOperationState.isCancelled](xref:@azure/storage-blob.PollOperationState.isCancelled)
- name: isCompleted
uid: '@azure/storage-blob.BlobBeginCopyFromUrlPollState.isCompleted'
package: '@azure/storage-blob'
summary: True if the operation has been completed.
fullName: isCompleted
remarks: ''
isDeprecated: false
syntax:
content: 'isCompleted?: boolean'
return:
description: ''
type: boolean
inheritanceDescription: >-
<b>Inherited From</b>
[PollOperationState.isCompleted](xref:@azure/storage-blob.PollOperationState.isCompleted)
- name: isStarted
uid: '@azure/storage-blob.BlobBeginCopyFromUrlPollState.isStarted'
package: '@azure/storage-blob'
summary: True if the operation has started.
fullName: isStarted
remarks: ''
isDeprecated: false
syntax:
content: 'isStarted?: boolean'
return:
description: ''
type: boolean
inheritanceDescription: >-
<b>Inherited From</b>
[PollOperationState.isStarted](xref:@azure/storage-blob.PollOperationState.isStarted)
- name: result
uid: '@azure/storage-blob.BlobBeginCopyFromUrlPollState.result'
package: '@azure/storage-blob'
summary: Will exist if the operation concluded in a result of an expected type.
fullName: result
remarks: ''
isDeprecated: false
syntax:
content: 'result?: BlobBeginCopyFromURLResponse'
return:
description: ''
type: <xref uid="@azure/storage-blob.BlobBeginCopyFromURLResponse" />
inheritanceDescription: >-
<b>Inherited From</b>
[PollOperationState.result](xref:@azure/storage-blob.PollOperationState.result)
extends: >-
<xref uid="@azure/storage-blob.PollOperationState" /><<xref
uid="@azure/storage-blob.BlobBeginCopyFromURLResponse" />>