TaskExecutionInformation Class

Package:

com.microsoft.azure.batch.protocol.models

• java.lang.Object
• • com.microsoft.azure.batch.protocol.models.TaskExecutionInformation

public class TaskExecutionInformation

Information about the execution of a task.

Method Summary

Modifier and Type	Method and Description
TaskContainerExecutionInformation	containerInfo() Get this property is set only if the task runs in a container context.
DateTime	endTime() Get this property is set only if the task is in the Completed state.
Integer	exitCode() Get this property is set only if the task 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 task (due to timeout, or user termination via the API) you may see an operating system-defined exit code.
TaskFailureInformation	failureInfo() Get this property is set only if the task is in the completed state and encountered a failure.
DateTime	lastRequeueTime() Get this property is set only if the requeueCount is nonzero.
DateTime	lastRetryTime() Get this element is present 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.
int	requeueCount() Get when the user removes nodes from a pool (by resizing/shrinking the pool) or when the job is being disabled, the user can specify that running tasks on the nodes be requeued for execution. This count tracks how many times the task has been requeued for these reasons.
TaskExecutionResult	result() Get if the value is 'failed', then the details of the failure can be found in the failureInfo property. Possible values include: 'success', 'failure'.
int	retryCount() Get 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.
DateTime	startTime() Get 'Running' corresponds to the running state, so if the task specifies resource files or application packages, then the start time reflects the time at which the task started downloading or deploying these. If the task has been restarted or retried, this is the most recent time at which the task started running. This property is present only for tasks that are in the running or completed state.
TaskExecutionInformation	withContainerInfo(TaskContainerExecutionInformation containerInfo) Set this property is set only if the task runs in a container context.
TaskExecutionInformation	withEndTime(DateTime endTime) Set this property is set only if the task is in the Completed state.
TaskExecutionInformation	withExitCode(Integer exitCode) Set this property is set only if the task 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 task (due to timeout, or user termination via the API) you may see an operating system-defined exit code.
TaskExecutionInformation	withFailureInfo(TaskFailureInformation failureInfo) Set this property is set only if the task is in the completed state and encountered a failure.
TaskExecutionInformation	withLastRequeueTime(DateTime lastRequeueTime) Set this property is set only if the requeueCount is nonzero.
TaskExecutionInformation	withLastRetryTime(DateTime lastRetryTime) Set this element is present 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.
TaskExecutionInformation	withRequeueCount(int requeueCount) Set when the user removes nodes from a pool (by resizing/shrinking the pool) or when the job is being disabled, the user can specify that running tasks on the nodes be requeued for execution. This count tracks how many times the task has been requeued for these reasons.
TaskExecutionInformation	withResult(TaskExecutionResult result) Set if the value is 'failed', then the details of the failure can be found in the failureInfo property. Possible values include: 'success', 'failure'.
TaskExecutionInformation	withRetryCount(int retryCount) Set 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.
TaskExecutionInformation	withStartTime(DateTime startTime) Set 'Running' corresponds to the running state, so if the task specifies resource files or application packages, then the start time reflects the time at which the task started downloading or deploying these. If the task has been restarted or retried, this is the most recent time at which the task started running. This property is present only for tasks that are in the running or completed state.

Method Details

containerInfo

public TaskContainerExecutionInformation containerInfo()

Get this property is set only if the task runs in a container context.

Returns:

the containerInfo value

endTime

public DateTime endTime()

Get this property is set only if the task is in the Completed state.

Returns:

the endTime value

exitCode

public Integer exitCode()

Get this property is set only if the task 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 task (due to timeout, or user termination via the API) you may see an operating system-defined exit code.

Returns:

the exitCode value

failureInfo

public TaskFailureInformation failureInfo()

Get this property is set only if the task is in the completed state and encountered a failure.

Returns:

the failureInfo value

lastRequeueTime

public DateTime lastRequeueTime()

Get this property is set only if the requeueCount is nonzero.

Returns:

the lastRequeueTime value

lastRetryTime

public DateTime lastRetryTime()

Get this element is present 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.

Returns:

the lastRetryTime value

requeueCount

public int requeueCount()

Get when the user removes nodes from a pool (by resizing/shrinking the pool) or when the job is being disabled, the user can specify that running tasks on the nodes be requeued for execution. This count tracks how many times the task has been requeued for these reasons.

Returns:

the requeueCount value

result

public TaskExecutionResult result()

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:

the result value

retryCount

public int retryCount()

Get 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.

Returns:

the retryCount value

startTime

public DateTime startTime()

Get 'Running' corresponds to the running state, so if the task specifies resource files or application packages, then the start time reflects the time at which the task started downloading or deploying these. If the task has been restarted or retried, this is the most recent time at which the task started running. This property is present only for tasks that are in the running or completed state.

Returns:

the startTime value

withContainerInfo

public TaskExecutionInformation withContainerInfo(TaskContainerExecutionInformation containerInfo)

Set this property is set only if the task runs in a container context.

Parameters:

containerInfo - the containerInfo value to set

Returns:

the TaskExecutionInformation object itself.

withEndTime

public TaskExecutionInformation withEndTime(DateTime endTime)

Set this property is set only if the task is in the Completed state.

Parameters:

endTime - the endTime value to set

Returns:

the TaskExecutionInformation object itself.

withExitCode

public TaskExecutionInformation withExitCode(Integer exitCode)

Set this property is set only if the task 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 task (due to timeout, or user termination via the API) you may see an operating system-defined exit code.

Parameters:

exitCode - the exitCode value to set

Returns:

the TaskExecutionInformation object itself.

withFailureInfo

public TaskExecutionInformation withFailureInfo(TaskFailureInformation failureInfo)

Set this property is set only if the task is in the completed state and encountered a failure.

Parameters:

failureInfo - the failureInfo value to set

Returns:

the TaskExecutionInformation object itself.

withLastRequeueTime

public TaskExecutionInformation withLastRequeueTime(DateTime lastRequeueTime)

Set this property is set only if the requeueCount is nonzero.

Parameters:

lastRequeueTime - the lastRequeueTime value to set

Returns:

the TaskExecutionInformation object itself.

withLastRetryTime

public TaskExecutionInformation withLastRetryTime(DateTime lastRetryTime)

Set this element is present 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.

Parameters:

lastRetryTime - the lastRetryTime value to set

Returns:

the TaskExecutionInformation object itself.

withRequeueCount

public TaskExecutionInformation withRequeueCount(int requeueCount)

Set when the user removes nodes from a pool (by resizing/shrinking the pool) or when the job is being disabled, the user can specify that running tasks on the nodes be requeued for execution. This count tracks how many times the task has been requeued for these reasons.

Parameters:

requeueCount - the requeueCount value to set

Returns:

the TaskExecutionInformation object itself.

withResult

public TaskExecutionInformation withResult(TaskExecutionResult result)

Set if the value is 'failed', then the details of the failure can be found in the failureInfo property. Possible values include: 'success', 'failure'.

Parameters:

result - the result value to set

Returns:

the TaskExecutionInformation object itself.

withRetryCount

public TaskExecutionInformation withRetryCount(int retryCount)

Set 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.

Parameters:

retryCount - the retryCount value to set

Returns:

the TaskExecutionInformation object itself.

withStartTime

public TaskExecutionInformation withStartTime(DateTime startTime)

Set 'Running' corresponds to the running state, so if the task specifies resource files or application packages, then the start time reflects the time at which the task started downloading or deploying these. If the task has been restarted or retried, this is the most recent time at which the task started running. This property is present only for tasks that are in the running or completed state.

Parameters:

startTime - the startTime value to set

Returns:

the TaskExecutionInformation object itself.