-
Notifications
You must be signed in to change notification settings - Fork 257
/
OperationDetails.xml
238 lines (238 loc) · 13.1 KB
/
OperationDetails.xml
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
<Type Name="OperationDetails" FullName="Azure.AI.FormRecognizer.DocumentAnalysis.OperationDetails">
<TypeSignature Language="C#" Value="public class OperationDetails" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit OperationDetails extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.AI.FormRecognizer.DocumentAnalysis.OperationDetails" />
<TypeSignature Language="VB.NET" Value="Public Class OperationDetails" />
<TypeSignature Language="F#" Value="type OperationDetails = class" />
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Get Operation response object.
Please note <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.OperationDetails" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
The available derived classes include <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentClassifierBuildOperationDetails" />, <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelBuildOperationDetails" />, <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelComposeOperationDetails" /> and <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelCopyToOperationDetails" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="CreatedOn">
<MemberSignature Language="C#" Value="public DateTimeOffset CreatedOn { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTimeOffset CreatedOn" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.DocumentAnalysis.OperationDetails.CreatedOn" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CreatedOn As DateTimeOffset" />
<MemberSignature Language="F#" Value="member this.CreatedOn : DateTimeOffset" Usage="Azure.AI.FormRecognizer.DocumentAnalysis.OperationDetails.CreatedOn" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTimeOffset</ReturnType>
</ReturnValue>
<Docs>
<summary>
Date and time (UTC) when the operation was created.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Error">
<MemberSignature Language="C#" Value="public Azure.ResponseError Error { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.ResponseError Error" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.DocumentAnalysis.OperationDetails.Error" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Error As ResponseError" />
<MemberSignature Language="F#" Value="member this.Error : Azure.ResponseError" Usage="Azure.AI.FormRecognizer.DocumentAnalysis.OperationDetails.Error" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.ResponseError</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the error that occurred during the operation. The value is <c>null</c> if the operation succeeds.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Kind">
<MemberSignature Language="C#" Value="public Azure.AI.FormRecognizer.DocumentAnalysis.DocumentOperationKind Kind { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Azure.AI.FormRecognizer.DocumentAnalysis.DocumentOperationKind Kind" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.DocumentAnalysis.OperationDetails.Kind" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Kind As DocumentOperationKind" />
<MemberSignature Language="F#" Value="member this.Kind : Azure.AI.FormRecognizer.DocumentAnalysis.DocumentOperationKind" Usage="Azure.AI.FormRecognizer.DocumentAnalysis.OperationDetails.Kind" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.FormRecognizer.DocumentAnalysis.DocumentOperationKind</ReturnType>
</ReturnValue>
<Docs>
<summary>
Type of operation.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LastUpdatedOn">
<MemberSignature Language="C#" Value="public DateTimeOffset LastUpdatedOn { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTimeOffset LastUpdatedOn" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.DocumentAnalysis.OperationDetails.LastUpdatedOn" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property LastUpdatedOn As DateTimeOffset" />
<MemberSignature Language="F#" Value="member this.LastUpdatedOn : DateTimeOffset" Usage="Azure.AI.FormRecognizer.DocumentAnalysis.OperationDetails.LastUpdatedOn" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTimeOffset</ReturnType>
</ReturnValue>
<Docs>
<summary>
Date and time (UTC) when the operation was last updated.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OperationId">
<MemberSignature Language="C#" Value="public string OperationId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string OperationId" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.DocumentAnalysis.OperationDetails.OperationId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property OperationId As String" />
<MemberSignature Language="F#" Value="member this.OperationId : string" Usage="Azure.AI.FormRecognizer.DocumentAnalysis.OperationDetails.OperationId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary> Operation ID. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PercentCompleted">
<MemberSignature Language="C#" Value="public int? PercentCompleted { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> PercentCompleted" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.DocumentAnalysis.OperationDetails.PercentCompleted" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property PercentCompleted As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.PercentCompleted : Nullable<int>" Usage="Azure.AI.FormRecognizer.DocumentAnalysis.OperationDetails.PercentCompleted" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary> Operation progress (0-100). </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ResourceLocation">
<MemberSignature Language="C#" Value="public Uri ResourceLocation { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Uri ResourceLocation" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.DocumentAnalysis.OperationDetails.ResourceLocation" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ResourceLocation As Uri" />
<MemberSignature Language="F#" Value="member this.ResourceLocation : Uri" Usage="Azure.AI.FormRecognizer.DocumentAnalysis.OperationDetails.ResourceLocation" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Uri</ReturnType>
</ReturnValue>
<Docs>
<summary>
URI of the resource targeted by this operation.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ServiceVersion">
<MemberSignature Language="C#" Value="public string ServiceVersion { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ServiceVersion" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.DocumentAnalysis.OperationDetails.ServiceVersion" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ServiceVersion As String" />
<MemberSignature Language="F#" Value="member this.ServiceVersion : string" Usage="Azure.AI.FormRecognizer.DocumentAnalysis.OperationDetails.ServiceVersion" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Service version used to create this operation.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Status">
<MemberSignature Language="C#" Value="public Azure.AI.FormRecognizer.DocumentAnalysis.DocumentOperationStatus Status { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Azure.AI.FormRecognizer.DocumentAnalysis.DocumentOperationStatus Status" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.DocumentAnalysis.OperationDetails.Status" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Status As DocumentOperationStatus" />
<MemberSignature Language="F#" Value="member this.Status : Azure.AI.FormRecognizer.DocumentAnalysis.DocumentOperationStatus" Usage="Azure.AI.FormRecognizer.DocumentAnalysis.OperationDetails.Status" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.FormRecognizer.DocumentAnalysis.DocumentOperationStatus</ReturnType>
</ReturnValue>
<Docs>
<summary> Operation status. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Tags">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyDictionary<string,string> Tags { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyDictionary`2<string, string> Tags" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.DocumentAnalysis.OperationDetails.Tags" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Tags As IReadOnlyDictionary(Of String, String)" />
<MemberSignature Language="F#" Value="member this.Tags : System.Collections.Generic.IReadOnlyDictionary<string, string>" Usage="Azure.AI.FormRecognizer.DocumentAnalysis.OperationDetails.Tags" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IReadOnlyDictionary<System.String,System.String></ReturnType>
</ReturnValue>
<Docs>
<summary> List of key-value tag attributes associated with the document model. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>