SubtaskInformation interface

Package:

@azure/batch

An interface representing SubtaskInformation.

Properties

containerInfo	Information about the container under which the Task is executing. This property is set only if the Task runs in a container context.
endTime	The time at which the subtask completed. This property is set only if the subtask is in the Completed state.
exitCode	The exit code of the program specified on the subtask command line. 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.
failureInfo	Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure.
id	The ID of the subtask.
nodeInfo	Information about the Compute Node on which the subtask ran.
previousState	The previous state of the subtask. This property is not set if the subtask is in its initial running state. Possible values include: 'preparing', 'running', 'completed'
previousStateTransitionTime	The time at which the subtask entered its previous state. This property is not set if the subtask is in its initial running state.
result	The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. Possible values include: 'success', 'failure'
startTime	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.
state	The current state of the subtask. Possible values include: 'preparing', 'running', 'completed'
stateTransitionTime	The time at which the subtask entered its current state.

Property Details

containerInfo

Information about the container under which the Task is executing. This property is set only if the Task runs in a container context.

containerInfo?: TaskContainerExecutionInformation

Property Value

TaskContainerExecutionInformation

endTime

The time at which the subtask completed. This property is set only if the subtask is in the Completed state.

endTime?: Date

Property Value

Date

exitCode

The exit code of the program specified on the subtask command line. 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.

exitCode?: number

Property Value

number

failureInfo

Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure.

failureInfo?: TaskFailureInformation

Property Value

TaskFailureInformation

id

The ID of the subtask.

id?: number

Property Value

number

nodeInfo

Information about the Compute Node on which the subtask ran.

nodeInfo?: ComputeNodeInformation

Property Value

ComputeNodeInformation

previousState

The previous state of the subtask. This property is not set if the subtask is in its initial running state. Possible values include: 'preparing', 'running', 'completed'

previousState?: SubtaskState

Property Value

SubtaskState

previousStateTransitionTime

The time at which the subtask entered its previous state. This property is not set if the subtask is in its initial running state.

previousStateTransitionTime?: Date

Property Value

Date

result

The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. Possible values include: 'success', 'failure'

result?: TaskExecutionResult

Property Value

TaskExecutionResult

startTime

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.

startTime?: Date

Property Value

Date

state

The current state of the subtask. Possible values include: 'preparing', 'running', 'completed'

state?: SubtaskState

Property Value

SubtaskState

stateTransitionTime

The time at which the subtask entered its current state.

stateTransitionTime?: Date

Property Value

Date