-
Notifications
You must be signed in to change notification settings - Fork 255
/
JobResponse.xml
326 lines (326 loc) · 18.3 KB
/
JobResponse.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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
<Type Name="JobResponse" FullName="Microsoft.Azure.Management.IotHub.Models.JobResponse">
<TypeSignature Language="C#" Value="public class JobResponse" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit JobResponse extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.IotHub.Models.JobResponse" />
<TypeSignature Language="VB.NET" Value="Public Class JobResponse" />
<TypeSignature Language="F#" Value="type JobResponse = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The properties of the Job Response object.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public JobResponse ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.IotHub.Models.JobResponse.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the JobResponse class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public JobResponse (string jobId = default, DateTime? startTimeUtc = default, DateTime? endTimeUtc = default, string type = default, Microsoft.Azure.Management.IotHub.Models.JobStatus? status = default, string failureReason = default, string statusMessage = default, string parentJobId = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string jobId, valuetype System.Nullable`1<valuetype System.DateTime> startTimeUtc, valuetype System.Nullable`1<valuetype System.DateTime> endTimeUtc, string type, valuetype System.Nullable`1<valuetype Microsoft.Azure.Management.IotHub.Models.JobStatus> status, string failureReason, string statusMessage, string parentJobId) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.IotHub.Models.JobResponse.#ctor(System.String,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.String,System.Nullable{Microsoft.Azure.Management.IotHub.Models.JobStatus},System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional jobId As String = Nothing, Optional startTimeUtc As Nullable(Of DateTime) = Nothing, Optional endTimeUtc As Nullable(Of DateTime) = Nothing, Optional type As String = Nothing, Optional status As Nullable(Of JobStatus) = Nothing, Optional failureReason As String = Nothing, Optional statusMessage As String = Nothing, Optional parentJobId As String = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Management.IotHub.Models.JobResponse : string * Nullable<DateTime> * Nullable<DateTime> * string * Nullable<Microsoft.Azure.Management.IotHub.Models.JobStatus> * string * string * string -> Microsoft.Azure.Management.IotHub.Models.JobResponse" Usage="new Microsoft.Azure.Management.IotHub.Models.JobResponse (jobId, startTimeUtc, endTimeUtc, type, status, failureReason, statusMessage, parentJobId)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="jobId" Type="System.String" />
<Parameter Name="startTimeUtc" Type="System.Nullable<System.DateTime>" />
<Parameter Name="endTimeUtc" Type="System.Nullable<System.DateTime>" />
<Parameter Name="type" Type="System.String" />
<Parameter Name="status" Type="System.Nullable<Microsoft.Azure.Management.IotHub.Models.JobStatus>" />
<Parameter Name="failureReason" Type="System.String" />
<Parameter Name="statusMessage" Type="System.String" />
<Parameter Name="parentJobId" Type="System.String" />
</Parameters>
<Docs>
<param name="jobId">The job identifier.</param>
<param name="startTimeUtc">The start time of the job.</param>
<param name="endTimeUtc">The time the job stopped
processing.</param>
<param name="type">The type of the job. Possible values include:
'unknown', 'export', 'import', 'backup', 'readDeviceProperties',
'writeDeviceProperties', 'updateDeviceConfiguration',
'rebootDevice', 'factoryResetDevice', 'firmwareUpdate'</param>
<param name="status">The status of the job. Possible values
include: 'unknown', 'enqueued', 'running', 'completed', 'failed',
'cancelled'</param>
<param name="failureReason">If status == failed, this string
containing the reason for the failure.</param>
<param name="statusMessage">The status message for the job.</param>
<param name="parentJobId">The job identifier of the parent job, if
any.</param>
<summary>
Initializes a new instance of the JobResponse class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EndTimeUtc">
<MemberSignature Language="C#" Value="public DateTime? EndTimeUtc { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTime> EndTimeUtc" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.JobResponse.EndTimeUtc" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EndTimeUtc As Nullable(Of DateTime)" />
<MemberSignature Language="F#" Value="member this.EndTimeUtc : Nullable<DateTime>" Usage="Microsoft.Azure.Management.IotHub.Models.JobResponse.EndTimeUtc" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonConverter(typeof(Microsoft.Rest.Serialization.DateTimeRfc1123JsonConverter))]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonConverter(typeof(Microsoft.Rest.Serialization.DateTimeRfc1123JsonConverter))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="endTimeUtc")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="endTimeUtc")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTime></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the time the job stopped processing.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FailureReason">
<MemberSignature Language="C#" Value="public string FailureReason { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string FailureReason" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.JobResponse.FailureReason" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property FailureReason As String" />
<MemberSignature Language="F#" Value="member this.FailureReason : string" Usage="Microsoft.Azure.Management.IotHub.Models.JobResponse.FailureReason" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="failureReason")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="failureReason")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets if status == failed, this string containing the reason for the
failure.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="JobId">
<MemberSignature Language="C#" Value="public string JobId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string JobId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.JobResponse.JobId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property JobId As String" />
<MemberSignature Language="F#" Value="member this.JobId : string" Usage="Microsoft.Azure.Management.IotHub.Models.JobResponse.JobId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="jobId")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="jobId")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the job identifier.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ParentJobId">
<MemberSignature Language="C#" Value="public string ParentJobId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ParentJobId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.JobResponse.ParentJobId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ParentJobId As String" />
<MemberSignature Language="F#" Value="member this.ParentJobId : string" Usage="Microsoft.Azure.Management.IotHub.Models.JobResponse.ParentJobId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="parentJobId")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="parentJobId")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the job identifier of the parent job, if any.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StartTimeUtc">
<MemberSignature Language="C#" Value="public DateTime? StartTimeUtc { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTime> StartTimeUtc" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.JobResponse.StartTimeUtc" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property StartTimeUtc As Nullable(Of DateTime)" />
<MemberSignature Language="F#" Value="member this.StartTimeUtc : Nullable<DateTime>" Usage="Microsoft.Azure.Management.IotHub.Models.JobResponse.StartTimeUtc" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonConverter(typeof(Microsoft.Rest.Serialization.DateTimeRfc1123JsonConverter))]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonConverter(typeof(Microsoft.Rest.Serialization.DateTimeRfc1123JsonConverter))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="startTimeUtc")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="startTimeUtc")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTime></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the start time of the job.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Status">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Management.IotHub.Models.JobStatus? Status { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Microsoft.Azure.Management.IotHub.Models.JobStatus> Status" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.JobResponse.Status" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Status As Nullable(Of JobStatus)" />
<MemberSignature Language="F#" Value="member this.Status : Nullable<Microsoft.Azure.Management.IotHub.Models.JobStatus>" Usage="Microsoft.Azure.Management.IotHub.Models.JobResponse.Status" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.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>System.Nullable<Microsoft.Azure.Management.IotHub.Models.JobStatus></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the status of the job. Possible values include: 'unknown',
'enqueued', 'running', 'completed', 'failed', 'cancelled'
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StatusMessage">
<MemberSignature Language="C#" Value="public string StatusMessage { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string StatusMessage" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.JobResponse.StatusMessage" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property StatusMessage As String" />
<MemberSignature Language="F#" Value="member this.StatusMessage : string" Usage="Microsoft.Azure.Management.IotHub.Models.JobResponse.StatusMessage" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="statusMessage")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="statusMessage")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the status message for the job.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Type">
<MemberSignature Language="C#" Value="public string Type { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Type" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.JobResponse.Type" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Type As String" />
<MemberSignature Language="F#" Value="member this.Type : string" Usage="Microsoft.Azure.Management.IotHub.Models.JobResponse.Type" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="type")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="type")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the type of the job. Possible values include: 'unknown',
'export', 'import', 'backup', 'readDeviceProperties',
'writeDeviceProperties', 'updateDeviceConfiguration',
'rebootDevice', 'factoryResetDevice', 'firmwareUpdate'
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>