-
Notifications
You must be signed in to change notification settings - Fork 256
/
SubtaskInformation.xml
309 lines (309 loc) · 17.2 KB
/
SubtaskInformation.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
<Type Name="SubtaskInformation" FullName="Microsoft.Azure.Batch.SubtaskInformation">
<TypeSignature Language="C#" Value="public class SubtaskInformation" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SubtaskInformation extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Batch.SubtaskInformation" />
<TypeSignature Language="VB.NET" Value="Public Class SubtaskInformation" />
<TypeSignature Language="F#" Value="type SubtaskInformation = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>14.0.0.0</AssemblyVersion>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
<AssemblyVersion>15.3.0.0</AssemblyVersion>
<AssemblyVersion>15.4.0.0</AssemblyVersion>
<AssemblyVersion>16.0.0.0</AssemblyVersion>
<AssemblyVersion>16.1.0.0</AssemblyVersion>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Information about an Azure Batch subtask.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="ComputeNodeInformation">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.ComputeNodeInformation ComputeNodeInformation { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.ComputeNodeInformation ComputeNodeInformation" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.SubtaskInformation.ComputeNodeInformation" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ComputeNodeInformation As ComputeNodeInformation" />
<MemberSignature Language="F#" Value="member this.ComputeNodeInformation : Microsoft.Azure.Batch.ComputeNodeInformation" Usage="Microsoft.Azure.Batch.SubtaskInformation.ComputeNodeInformation" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.ComputeNodeInformation</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the information about the compute node on which the subtask ran.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ContainerInformation">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.TaskContainerExecutionInformation ContainerInformation { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.TaskContainerExecutionInformation ContainerInformation" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.SubtaskInformation.ContainerInformation" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ContainerInformation As TaskContainerExecutionInformation" />
<MemberSignature Language="F#" Value="member this.ContainerInformation : Microsoft.Azure.Batch.TaskContainerExecutionInformation" Usage="Microsoft.Azure.Batch.SubtaskInformation.ContainerInformation" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.TaskContainerExecutionInformation</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets information about the container under which the task is executing.
</summary>
<value>To be added.</value>
<remarks>
This property is set only if the task runs in a container context.
</remarks>
</Docs>
</Member>
<Member MemberName="EndTime">
<MemberSignature Language="C#" Value="public DateTime? EndTime { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTime> EndTime" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.SubtaskInformation.EndTime" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EndTime As Nullable(Of DateTime)" />
<MemberSignature Language="F#" Value="member this.EndTime : Nullable<DateTime>" Usage="Microsoft.Azure.Batch.SubtaskInformation.EndTime" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTime></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the time at which the subtask completed. This property is set only if the subtask is in the <see cref="F:Microsoft.Azure.Batch.Common.SubtaskState.Completed" />
state.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExitCode">
<MemberSignature Language="C#" Value="public int? ExitCode { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> ExitCode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.SubtaskInformation.ExitCode" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ExitCode As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.ExitCode : Nullable<int>" Usage="Microsoft.Azure.Batch.SubtaskInformation.ExitCode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the exit code of the program specified on the subtask command line.
</summary>
<value>To be added.</value>
<remarks>
This property is only returned if the subtask is in the <see cref="F:Microsoft.Azure.Batch.Common.SubtaskState.Completed" /> state. The
exit code for a process reflects the specific convention implemented by the application developer for that process.
If you use the exit code value to make decisions in your code, be sure that you know the exit code convention
used by the application process. Note that the exit code may also be generated by the compute node operating
system, such as when a process is forcibly terminated.
</remarks>
</Docs>
</Member>
<Member MemberName="FailureInformation">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.TaskFailureInformation FailureInformation { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.TaskFailureInformation FailureInformation" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.SubtaskInformation.FailureInformation" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property FailureInformation As TaskFailureInformation" />
<MemberSignature Language="F#" Value="member this.FailureInformation : Microsoft.Azure.Batch.TaskFailureInformation" Usage="Microsoft.Azure.Batch.SubtaskInformation.FailureInformation" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.TaskFailureInformation</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets information describing the task failure, if any.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public int? Id { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> Id" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.SubtaskInformation.Id" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Id As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.Id : Nullable<int>" Usage="Microsoft.Azure.Batch.SubtaskInformation.Id" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the id of the subtask.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PreviousState">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.Common.SubtaskState? PreviousState { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Common.SubtaskState> PreviousState" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.SubtaskInformation.PreviousState" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property PreviousState As Nullable(Of SubtaskState)" />
<MemberSignature Language="F#" Value="member this.PreviousState : Nullable<Microsoft.Azure.Batch.Common.SubtaskState>" Usage="Microsoft.Azure.Batch.SubtaskInformation.PreviousState" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<Microsoft.Azure.Batch.Common.SubtaskState></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the previous state of the subtask. This property is not set if the subtask is in its initial <see cref="F:Microsoft.Azure.Batch.Common.SubtaskState.Running" />
state.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PreviousStateTransitionTime">
<MemberSignature Language="C#" Value="public DateTime? PreviousStateTransitionTime { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTime> PreviousStateTransitionTime" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.SubtaskInformation.PreviousStateTransitionTime" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property PreviousStateTransitionTime As Nullable(Of DateTime)" />
<MemberSignature Language="F#" Value="member this.PreviousStateTransitionTime : Nullable<DateTime>" Usage="Microsoft.Azure.Batch.SubtaskInformation.PreviousStateTransitionTime" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTime></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the time at which the subtask entered its previous state. This property is not set if the subtask is in
its initial <see cref="F:Microsoft.Azure.Batch.Common.SubtaskState.Running" /> state.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Result">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.Common.TaskExecutionResult? Result { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Common.TaskExecutionResult> Result" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.SubtaskInformation.Result" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Result As Nullable(Of TaskExecutionResult)" />
<MemberSignature Language="F#" Value="member this.Result : Nullable<Microsoft.Azure.Batch.Common.TaskExecutionResult>" Usage="Microsoft.Azure.Batch.SubtaskInformation.Result" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<Microsoft.Azure.Batch.Common.TaskExecutionResult></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the result of the task execution.
</summary>
<value>To be added.</value>
<remarks>
If the value is <see cref="F:Microsoft.Azure.Batch.Common.TaskExecutionResult.Failure" />, then the details of the failure can be found
in the <see cref="P:Microsoft.Azure.Batch.SubtaskInformation.FailureInformation" /> property.
</remarks>
</Docs>
</Member>
<Member MemberName="StartTime">
<MemberSignature Language="C#" Value="public DateTime? StartTime { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTime> StartTime" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.SubtaskInformation.StartTime" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property StartTime As Nullable(Of DateTime)" />
<MemberSignature Language="F#" Value="member this.StartTime : Nullable<DateTime>" Usage="Microsoft.Azure.Batch.SubtaskInformation.StartTime" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTime></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the time at which the subtask started running. If the subtask has been restarted or retried, this is the
most recent time at which the subtask started running.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="State">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.Common.SubtaskState? State { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Common.SubtaskState> State" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.SubtaskInformation.State" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property State As Nullable(Of SubtaskState)" />
<MemberSignature Language="F#" Value="member this.State : Nullable<Microsoft.Azure.Batch.Common.SubtaskState>" Usage="Microsoft.Azure.Batch.SubtaskInformation.State" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<Microsoft.Azure.Batch.Common.SubtaskState></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the current state of the subtask.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StateTransitionTime">
<MemberSignature Language="C#" Value="public DateTime? StateTransitionTime { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTime> StateTransitionTime" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.SubtaskInformation.StateTransitionTime" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property StateTransitionTime As Nullable(Of DateTime)" />
<MemberSignature Language="F#" Value="member this.StateTransitionTime : Nullable<DateTime>" Usage="Microsoft.Azure.Batch.SubtaskInformation.StateTransitionTime" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTime></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the time at which the subtask entered its current state.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>