-
Notifications
You must be signed in to change notification settings - Fork 245
/
com.microsoft.azure.batch.protocol.models.SubtaskInformation.yml
323 lines (323 loc) · 24.6 KB
/
com.microsoft.azure.batch.protocol.models.SubtaskInformation.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
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
### YamlMime:JavaType
uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation"
name: "SubtaskInformation"
nameWithType: "SubtaskInformation"
summary: "Information about an Azure Batch subtask."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **SubtaskInformation**"
constructors:
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.SubtaskInformation()"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.SubtaskInformation()"
name: "SubtaskInformation()"
nameWithType: "SubtaskInformation.SubtaskInformation()"
syntax: "public SubtaskInformation()"
methods:
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.containerInfo()"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.containerInfo()"
name: "containerInfo()"
nameWithType: "SubtaskInformation.containerInfo()"
summary: "Get this property is set only if the Task runs in a container context."
syntax: "public TaskContainerExecutionInformation containerInfo()"
desc: "Get this property is set only if the Task runs in a container context."
returns:
description: "the containerInfo value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.TaskContainerExecutionInformation?alt=com.microsoft.azure.batch.protocol.models.TaskContainerExecutionInformation&text=TaskContainerExecutionInformation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.endTime()"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.endTime()"
name: "endTime()"
nameWithType: "SubtaskInformation.endTime()"
summary: "Get this property is set only if the subtask is in the Completed state."
syntax: "public DateTime endTime()"
desc: "Get this property is set only if the subtask is in the Completed state."
returns:
description: "the endTime value"
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.exitCode()"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.exitCode()"
name: "exitCode()"
nameWithType: "SubtaskInformation.exitCode()"
summary: "Get this property is set only if the subtask is in the completed state."
syntax: "public Integer exitCode()"
desc: "Get this property is set only if the subtask is in the completed state. In general, 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. However, if the Batch service terminates the subtask (due to timeout, or user termination via the API) you may see an operating system-defined exit code."
returns:
description: "the exitCode value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.failureInfo()"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.failureInfo()"
name: "failureInfo()"
nameWithType: "SubtaskInformation.failureInfo()"
summary: "Get this property is set only if the Task is in the completed state and encountered a failure."
syntax: "public TaskFailureInformation failureInfo()"
desc: "Get this property is set only if the Task is in the completed state and encountered a failure."
returns:
description: "the failureInfo value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.TaskFailureInformation?alt=com.microsoft.azure.batch.protocol.models.TaskFailureInformation&text=TaskFailureInformation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.id()"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.id()"
name: "id()"
nameWithType: "SubtaskInformation.id()"
summary: "Get the id value."
syntax: "public Integer id()"
desc: "Get the id value."
returns:
description: "the id value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.nodeInfo()"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.nodeInfo()"
name: "nodeInfo()"
nameWithType: "SubtaskInformation.nodeInfo()"
summary: "Get the node<wbr>Info value."
syntax: "public ComputeNodeInformation nodeInfo()"
desc: "Get the nodeInfo value."
returns:
description: "the nodeInfo value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeInformation?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeInformation&text=ComputeNodeInformation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.previousState()"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.previousState()"
name: "previousState()"
nameWithType: "SubtaskInformation.previousState()"
summary: "Get this property is not set if the subtask is in its initial running state."
syntax: "public SubtaskState previousState()"
desc: "Get this property is not set if the subtask is in its initial running state. Possible values include: 'preparing', 'running', 'completed'."
returns:
description: "the previousState value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.SubtaskState?alt=com.microsoft.azure.batch.protocol.models.SubtaskState&text=SubtaskState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.previousStateTransitionTime()"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.previousStateTransitionTime()"
name: "previousStateTransitionTime()"
nameWithType: "SubtaskInformation.previousStateTransitionTime()"
summary: "Get this property is not set if the subtask is in its initial running state."
syntax: "public DateTime previousStateTransitionTime()"
desc: "Get this property is not set if the subtask is in its initial running state."
returns:
description: "the previousStateTransitionTime value"
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.result()"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.result()"
name: "result()"
nameWithType: "SubtaskInformation.result()"
summary: "Get if the value is 'failed', then the details of the failure can be found in the failure<wbr>Info property."
syntax: "public TaskExecutionResult result()"
desc: "Get if the value is 'failed', then the details of the failure can be found in the failureInfo property. Possible values include: 'success', 'failure'."
returns:
description: "the result value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.TaskExecutionResult?alt=com.microsoft.azure.batch.protocol.models.TaskExecutionResult&text=TaskExecutionResult\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.startTime()"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.startTime()"
name: "startTime()"
nameWithType: "SubtaskInformation.startTime()"
summary: "Get the start<wbr>Time value."
syntax: "public DateTime startTime()"
desc: "Get the startTime value."
returns:
description: "the startTime value"
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.state()"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.state()"
name: "state()"
nameWithType: "SubtaskInformation.state()"
summary: "Get possible values include: 'preparing', 'running', 'completed'."
syntax: "public SubtaskState state()"
desc: "Get possible values include: 'preparing', 'running', 'completed'."
returns:
description: "the state value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.SubtaskState?alt=com.microsoft.azure.batch.protocol.models.SubtaskState&text=SubtaskState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.stateTransitionTime()"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.stateTransitionTime()"
name: "stateTransitionTime()"
nameWithType: "SubtaskInformation.stateTransitionTime()"
summary: "Get the state<wbr>Transition<wbr>Time value."
syntax: "public DateTime stateTransitionTime()"
desc: "Get the stateTransitionTime value."
returns:
description: "the stateTransitionTime value"
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withContainerInfo(com.microsoft.azure.batch.protocol.models.TaskContainerExecutionInformation)"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withContainerInfo(TaskContainerExecutionInformation containerInfo)"
name: "withContainerInfo(TaskContainerExecutionInformation containerInfo)"
nameWithType: "SubtaskInformation.withContainerInfo(TaskContainerExecutionInformation containerInfo)"
summary: "Set this property is set only if the Task runs in a container context."
parameters:
- description: "the containerInfo value to set"
name: "containerInfo"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.TaskContainerExecutionInformation?alt=com.microsoft.azure.batch.protocol.models.TaskContainerExecutionInformation&text=TaskContainerExecutionInformation\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SubtaskInformation withContainerInfo(TaskContainerExecutionInformation containerInfo)"
desc: "Set this property is set only if the Task runs in a container context."
returns:
description: "the SubtaskInformation object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.SubtaskInformation?alt=com.microsoft.azure.batch.protocol.models.SubtaskInformation&text=SubtaskInformation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withEndTime(org.joda.time.DateTime)"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withEndTime(DateTime endTime)"
name: "withEndTime(DateTime endTime)"
nameWithType: "SubtaskInformation.withEndTime(DateTime endTime)"
summary: "Set this property is set only if the subtask is in the Completed state."
parameters:
- description: "the endTime value to set"
name: "endTime"
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SubtaskInformation withEndTime(DateTime endTime)"
desc: "Set this property is set only if the subtask is in the Completed state."
returns:
description: "the SubtaskInformation object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.SubtaskInformation?alt=com.microsoft.azure.batch.protocol.models.SubtaskInformation&text=SubtaskInformation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withExitCode(java.lang.Integer)"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withExitCode(Integer exitCode)"
name: "withExitCode(Integer exitCode)"
nameWithType: "SubtaskInformation.withExitCode(Integer exitCode)"
summary: "Set this property is set only if the subtask is in the completed state."
parameters:
- description: "the exitCode value to set"
name: "exitCode"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public SubtaskInformation withExitCode(Integer exitCode)"
desc: "Set this property is set only if the subtask is in the completed state. In general, 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. However, if the Batch service terminates the subtask (due to timeout, or user termination via the API) you may see an operating system-defined exit code."
returns:
description: "the SubtaskInformation object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.SubtaskInformation?alt=com.microsoft.azure.batch.protocol.models.SubtaskInformation&text=SubtaskInformation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withFailureInfo(com.microsoft.azure.batch.protocol.models.TaskFailureInformation)"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withFailureInfo(TaskFailureInformation failureInfo)"
name: "withFailureInfo(TaskFailureInformation failureInfo)"
nameWithType: "SubtaskInformation.withFailureInfo(TaskFailureInformation failureInfo)"
summary: "Set this property is set only if the Task is in the completed state and encountered a failure."
parameters:
- description: "the failureInfo value to set"
name: "failureInfo"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.TaskFailureInformation?alt=com.microsoft.azure.batch.protocol.models.TaskFailureInformation&text=TaskFailureInformation\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SubtaskInformation withFailureInfo(TaskFailureInformation failureInfo)"
desc: "Set this property is set only if the Task is in the completed state and encountered a failure."
returns:
description: "the SubtaskInformation object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.SubtaskInformation?alt=com.microsoft.azure.batch.protocol.models.SubtaskInformation&text=SubtaskInformation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withId(java.lang.Integer)"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withId(Integer id)"
name: "withId(Integer id)"
nameWithType: "SubtaskInformation.withId(Integer id)"
summary: "Set the id value."
parameters:
- description: "the id value to set"
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public SubtaskInformation withId(Integer id)"
desc: "Set the id value."
returns:
description: "the SubtaskInformation object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.SubtaskInformation?alt=com.microsoft.azure.batch.protocol.models.SubtaskInformation&text=SubtaskInformation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withNodeInfo(com.microsoft.azure.batch.protocol.models.ComputeNodeInformation)"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withNodeInfo(ComputeNodeInformation nodeInfo)"
name: "withNodeInfo(ComputeNodeInformation nodeInfo)"
nameWithType: "SubtaskInformation.withNodeInfo(ComputeNodeInformation nodeInfo)"
summary: "Set the node<wbr>Info value."
parameters:
- description: "the nodeInfo value to set"
name: "nodeInfo"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeInformation?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeInformation&text=ComputeNodeInformation\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SubtaskInformation withNodeInfo(ComputeNodeInformation nodeInfo)"
desc: "Set the nodeInfo value."
returns:
description: "the SubtaskInformation object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.SubtaskInformation?alt=com.microsoft.azure.batch.protocol.models.SubtaskInformation&text=SubtaskInformation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withPreviousState(com.microsoft.azure.batch.protocol.models.SubtaskState)"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withPreviousState(SubtaskState previousState)"
name: "withPreviousState(SubtaskState previousState)"
nameWithType: "SubtaskInformation.withPreviousState(SubtaskState previousState)"
summary: "Set this property is not set if the subtask is in its initial running state."
parameters:
- description: "the previousState value to set"
name: "previousState"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.SubtaskState?alt=com.microsoft.azure.batch.protocol.models.SubtaskState&text=SubtaskState\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SubtaskInformation withPreviousState(SubtaskState previousState)"
desc: "Set this property is not set if the subtask is in its initial running state. Possible values include: 'preparing', 'running', 'completed'."
returns:
description: "the SubtaskInformation object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.SubtaskInformation?alt=com.microsoft.azure.batch.protocol.models.SubtaskInformation&text=SubtaskInformation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withPreviousStateTransitionTime(org.joda.time.DateTime)"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withPreviousStateTransitionTime(DateTime previousStateTransitionTime)"
name: "withPreviousStateTransitionTime(DateTime previousStateTransitionTime)"
nameWithType: "SubtaskInformation.withPreviousStateTransitionTime(DateTime previousStateTransitionTime)"
summary: "Set this property is not set if the subtask is in its initial running state."
parameters:
- description: "the previousStateTransitionTime value to set"
name: "previousStateTransitionTime"
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SubtaskInformation withPreviousStateTransitionTime(DateTime previousStateTransitionTime)"
desc: "Set this property is not set if the subtask is in its initial running state."
returns:
description: "the SubtaskInformation object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.SubtaskInformation?alt=com.microsoft.azure.batch.protocol.models.SubtaskInformation&text=SubtaskInformation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withResult(com.microsoft.azure.batch.protocol.models.TaskExecutionResult)"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withResult(TaskExecutionResult result)"
name: "withResult(TaskExecutionResult result)"
nameWithType: "SubtaskInformation.withResult(TaskExecutionResult result)"
summary: "Set if the value is 'failed', then the details of the failure can be found in the failure<wbr>Info property."
parameters:
- description: "the result value to set"
name: "result"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.TaskExecutionResult?alt=com.microsoft.azure.batch.protocol.models.TaskExecutionResult&text=TaskExecutionResult\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SubtaskInformation withResult(TaskExecutionResult result)"
desc: "Set if the value is 'failed', then the details of the failure can be found in the failureInfo property. Possible values include: 'success', 'failure'."
returns:
description: "the SubtaskInformation object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.SubtaskInformation?alt=com.microsoft.azure.batch.protocol.models.SubtaskInformation&text=SubtaskInformation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withStartTime(org.joda.time.DateTime)"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withStartTime(DateTime startTime)"
name: "withStartTime(DateTime startTime)"
nameWithType: "SubtaskInformation.withStartTime(DateTime startTime)"
summary: "Set the start<wbr>Time value."
parameters:
- description: "the startTime value to set"
name: "startTime"
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SubtaskInformation withStartTime(DateTime startTime)"
desc: "Set the startTime value."
returns:
description: "the SubtaskInformation object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.SubtaskInformation?alt=com.microsoft.azure.batch.protocol.models.SubtaskInformation&text=SubtaskInformation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withState(com.microsoft.azure.batch.protocol.models.SubtaskState)"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withState(SubtaskState state)"
name: "withState(SubtaskState state)"
nameWithType: "SubtaskInformation.withState(SubtaskState state)"
summary: "Set possible values include: 'preparing', 'running', 'completed'."
parameters:
- description: "the state value to set"
name: "state"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.SubtaskState?alt=com.microsoft.azure.batch.protocol.models.SubtaskState&text=SubtaskState\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SubtaskInformation withState(SubtaskState state)"
desc: "Set possible values include: 'preparing', 'running', 'completed'."
returns:
description: "the SubtaskInformation object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.SubtaskInformation?alt=com.microsoft.azure.batch.protocol.models.SubtaskInformation&text=SubtaskInformation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withStateTransitionTime(org.joda.time.DateTime)"
fullName: "com.microsoft.azure.batch.protocol.models.SubtaskInformation.withStateTransitionTime(DateTime stateTransitionTime)"
name: "withStateTransitionTime(DateTime stateTransitionTime)"
nameWithType: "SubtaskInformation.withStateTransitionTime(DateTime stateTransitionTime)"
summary: "Set the state<wbr>Transition<wbr>Time value."
parameters:
- description: "the stateTransitionTime value to set"
name: "stateTransitionTime"
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SubtaskInformation withStateTransitionTime(DateTime stateTransitionTime)"
desc: "Set the stateTransitionTime value."
returns:
description: "the SubtaskInformation object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.SubtaskInformation?alt=com.microsoft.azure.batch.protocol.models.SubtaskInformation&text=SubtaskInformation\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Information about an Azure Batch subtask."
metadata: {}
package: "com.microsoft.azure.batch.protocol.models"
artifact: com.microsoft.azure:azure-batch:11.2.0