JobPreparationTaskExecutionInformation interface

Package:

@azure/batch

An interface representing JobPreparationTaskExecutionInformation.

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 Job Preparation Task completed. This property is set only if the Task is in the Completed state.
exitCode	The exit code of the program specified on the Task command line. This parameter is returned only if the Task is in the 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.
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.
lastRetryTime	The most recent time at which a retry of the Job Preparation Task started running. This property is set only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not.
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'
retryCount	The number of times the Task has been retried by the Batch service. Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints. Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints.
startTime	The time at which the Task started running. If the Task has been restarted or retried, this is the most recent time at which the Task started running.
state	The current state of the Job Preparation Task on the Compute Node. Possible values include: 'running', 'completed'
taskRootDirectory	The root directory of the Job Preparation Task on the Compute Node. You can use this path to retrieve files created by the Task, such as log files.
taskRootDirectoryUrl	The URL to the root directory of the Job Preparation Task on the Compute Node.

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 Job Preparation Task completed. This property is set only if the Task is in the Completed state.

endTime?: Date

Property Value

Date

exitCode

The exit code of the program specified on the Task command line. This parameter is returned only if the Task is in the 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.

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

lastRetryTime

The most recent time at which a retry of the Job Preparation Task started running. This property is set only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not.

lastRetryTime?: 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

retryCount

The number of times the Task has been retried by the Batch service. Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints. Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints.

retryCount: number

Property Value

number

startTime

The time at which the Task started running. If the Task has been restarted or retried, this is the most recent time at which the Task started running.

startTime: Date

Property Value

Date

state

The current state of the Job Preparation Task on the Compute Node. Possible values include: 'running', 'completed'

state: JobPreparationTaskState

Property Value

JobPreparationTaskState

taskRootDirectory

The root directory of the Job Preparation Task on the Compute Node. You can use this path to retrieve files created by the Task, such as log files.

taskRootDirectory?: string

Property Value

string

taskRootDirectoryUrl

The URL to the root directory of the Job Preparation Task on the Compute Node.

taskRootDirectoryUrl?: string

Property Value

string