-
Notifications
You must be signed in to change notification settings - Fork 258
/
OperationStatus.xml
285 lines (285 loc) · 16.8 KB
/
OperationStatus.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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
<Type Name="OperationStatus" FullName="Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus">
<TypeSignature Language="C#" Value="public class OperationStatus" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit OperationStatus extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus" />
<TypeSignature Language="VB.NET" Value="Public Class OperationStatus" />
<TypeSignature Language="F#" Value="type OperationStatus = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.7.0.0</AssemblyVersion>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Operation status object. Operation refers to the asynchronous backend
task including taking a snapshot and applying a snapshot.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public OperationStatus ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the OperationStatus class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public OperationStatus (Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatusType status, DateTime createdTime, DateTime? lastActionTime = default, DateTime? finishedTime = default, string resourceLocation = default, string message = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatusType status, valuetype System.DateTime createdTime, valuetype System.Nullable`1<valuetype System.DateTime> lastActionTime, valuetype System.Nullable`1<valuetype System.DateTime> finishedTime, string resourceLocation, string message) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus.#ctor(Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatusType,System.DateTime,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (status As OperationStatusType, createdTime As DateTime, Optional lastActionTime As Nullable(Of DateTime) = Nothing, Optional finishedTime As Nullable(Of DateTime) = Nothing, Optional resourceLocation As String = Nothing, Optional message As String = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus : Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatusType * DateTime * Nullable<DateTime> * Nullable<DateTime> * string * string -> Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus" Usage="new Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus (status, createdTime, lastActionTime, finishedTime, resourceLocation, message)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="status" Type="Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatusType" />
<Parameter Name="createdTime" Type="System.DateTime" />
<Parameter Name="lastActionTime" Type="System.Nullable<System.DateTime>" />
<Parameter Name="finishedTime" Type="System.Nullable<System.DateTime>" />
<Parameter Name="resourceLocation" Type="System.String" />
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<param name="status">To be added.</param>
<param name="createdTime">To be added.</param>
<param name="lastActionTime">To be added.</param>
<param name="finishedTime">To be added.</param>
<param name="resourceLocation">To be added.</param>
<param name="message">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreatedTime">
<MemberSignature Language="C#" Value="public DateTime CreatedTime { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime CreatedTime" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus.CreatedTime" />
<MemberSignature Language="VB.NET" Value="Public Property CreatedTime As DateTime" />
<MemberSignature Language="F#" Value="member this.CreatedTime : DateTime with get, set" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus.CreatedTime" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="createdTime")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="createdTime")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a combined UTC date and time string that describes the
time when the operation (take or apply a snapshot) is requested.
E.g. 2018-12-25T11:41:02.2331413Z.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FinishedTime">
<MemberSignature Language="C#" Value="public DateTime? FinishedTime { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTime> FinishedTime" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus.FinishedTime" />
<MemberSignature Language="VB.NET" Value="Public Property FinishedTime As Nullable(Of DateTime)" />
<MemberSignature Language="F#" Value="member this.FinishedTime : Nullable<DateTime> with get, set" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus.FinishedTime" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="finishedTime")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="finishedTime")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTime></ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LastActionTime">
<MemberSignature Language="C#" Value="public DateTime? LastActionTime { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTime> LastActionTime" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus.LastActionTime" />
<MemberSignature Language="VB.NET" Value="Public Property LastActionTime As Nullable(Of DateTime)" />
<MemberSignature Language="F#" Value="member this.LastActionTime : Nullable<DateTime> with get, set" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus.LastActionTime" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="lastActionTime")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="lastActionTime")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTime></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a combined UTC date and time string that describes the
last time the operation (take or apply a snapshot) is actively
migrating data. The lastActionTime will keep increasing until the
operation finishes. E.g. 2018-12-25T11:51:27.8705696Z.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Message">
<MemberSignature Language="C#" Value="public string Message { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Message" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus.Message" />
<MemberSignature Language="VB.NET" Value="Public Property Message As String" />
<MemberSignature Language="F#" Value="member this.Message : string with get, set" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus.Message" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="message")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="message")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets show failure message when operation fails (omitted
when operation succeeds).
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ResourceLocation">
<MemberSignature Language="C#" Value="public string ResourceLocation { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ResourceLocation" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus.ResourceLocation" />
<MemberSignature Language="VB.NET" Value="Public Property ResourceLocation As String" />
<MemberSignature Language="F#" Value="member this.ResourceLocation : string with get, set" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus.ResourceLocation" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="resourceLocation")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="resourceLocation")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets when the operation succeeds successfully, for snapshot
taking operation the snapshot id will be included in this field,
and for snapshot applying operation, the path to get the target
object will be returned in this field.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Status">
<MemberSignature Language="C#" Value="public Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatusType Status { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatusType Status" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus.Status" />
<MemberSignature Language="VB.NET" Value="Public Property Status As OperationStatusType" />
<MemberSignature Language="F#" Value="member this.Status : Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatusType with get, set" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus.Status" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="status")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="status")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatusType</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets operation status: notstarted, running, succeeded,
failed. If the operation is requested and waiting to perform, the
status is notstarted. If the operation is ongoing in backend, the
status is running. Status succeeded means the operation is
completed successfully, specifically for snapshot taking operation,
it illustrates the snapshot is well taken and ready to apply, and
for snapshot applying operation, it presents the target object has
finished creating by the snapshot and ready to be used. Status
failed is often caused by editing the source object while taking
the snapshot or editing the target object while applying the
snapshot before completion, see the field "message" to check the
failure reason. Possible values include: 'notstarted', 'running',
'succeeded', 'failed'
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="public virtual void Validate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Validate() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.Models.OperationStatus.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Validate ()" />
<MemberSignature Language="F#" Value="abstract member Validate : unit -> unit
override this.Validate : unit -> unit" Usage="operationStatus.Validate " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Validate the object.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown if validation fails
</exception>
</Docs>
</Member>
</Members>
</Type>