TaskExecutionInformation Class
- java.
lang. Object - com.
microsoft. azure. batch. protocol. models. TaskExecutionInformation
- com.
public class TaskExecutionInformation
Information about the execution of a Task.
Constructor Summary
Constructor | Description | |
---|---|---|
TaskExecutionInformation() |
Method Summary
Modifier and Type | Method and Description |
---|---|
Task |
containerInfo()
Get this property is set only if the Task runs in a container context. |
org.joda.time.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. |
Task |
failureInfo()
Get this property is set only if the Task is in the completed state and encountered a failure. |
org.joda.time.DateTime |
lastRequeueTime()
Get this property is set only if the requeue |
org.joda.time.DateTime |
lastRetryTime()
Get this element is present only if the Task was retried (i. |
int |
requeueCount()
Get when the user removes Compute 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 Compute Nodes be requeued for execution. |
Task |
result()
Get if the value is 'failed', then the details of the failure can be found in the 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. |
org.joda.time.DateTime |
startTime()
Get 'Running' corresponds to the running state, so if the Task specifies resource files or Packages, then the start time reflects the time at which the Task started downloading or deploying these. |
Task |
withContainerInfo(TaskContainerExecutionInformation containerInfo)
Set this property is set only if the Task runs in a container context. |
Task |
withEndTime(DateTime endTime)
Set this property is set only if the Task is in the Completed state. |
Task |
withExitCode(Integer exitCode)
Set this property is set only if the Task is in the completed state. |
Task |
withFailureInfo(TaskFailureInformation failureInfo)
Set this property is set only if the Task is in the completed state and encountered a failure. |
Task |
withLastRequeueTime(DateTime lastRequeueTime)
Set this property is set only if the requeue |
Task |
withLastRetryTime(DateTime lastRetryTime)
Set this element is present only if the Task was retried (i. |
Task |
withRequeueCount(int requeueCount)
Set when the user removes Compute 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 Compute Nodes be requeued for execution. |
Task |
withResult(TaskExecutionResult result)
Set if the value is 'failed', then the details of the failure can be found in the failure |
Task |
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. |
Task |
withStartTime(DateTime startTime)
Set 'Running' corresponds to the running state, so if the Task specifies resource files or Packages, then the start time reflects the time at which the Task started downloading or deploying these. |
Methods inherited from java.lang.Object
Constructor Details
TaskExecutionInformation
public TaskExecutionInformation()
Method Details
containerInfo
public TaskContainerExecutionInformation containerInfo()
Get this property is set only if the Task runs in a container context.
Returns:
endTime
public DateTime endTime()
Get this property is set only if the Task is in the Completed state.
Returns:
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:
failureInfo
public TaskFailureInformation failureInfo()
Get this property is set only if the Task is in the completed state and encountered a failure.
Returns:
lastRequeueTime
public DateTime lastRequeueTime()
Get this property is set only if the requeueCount is nonzero.
Returns:
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:
requeueCount
public int requeueCount()
Get when the user removes Compute 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 Compute Nodes be requeued for execution. This count tracks how many times the Task has been requeued for these reasons.
Returns:
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:
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:
startTime
public DateTime startTime()
Get 'Running' corresponds to the running state, so if the Task specifies resource files or 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:
withContainerInfo
public TaskExecutionInformation withContainerInfo(TaskContainerExecutionInformation containerInfo)
Set this property is set only if the Task runs in a container context.
Parameters:
Returns:
withEndTime
public TaskExecutionInformation withEndTime(DateTime endTime)
Set this property is set only if the Task is in the Completed state.
Parameters:
Returns:
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:
Returns:
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:
Returns:
withLastRequeueTime
public TaskExecutionInformation withLastRequeueTime(DateTime lastRequeueTime)
Set this property is set only if the requeueCount is nonzero.
Parameters:
Returns:
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:
Returns:
withRequeueCount
public TaskExecutionInformation withRequeueCount(int requeueCount)
Set when the user removes Compute 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 Compute Nodes be requeued for execution. This count tracks how many times the Task has been requeued for these reasons.
Parameters:
Returns:
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:
Returns:
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:
Returns:
withStartTime
public TaskExecutionInformation withStartTime(DateTime startTime)
Set 'Running' corresponds to the running state, so if the Task specifies resource files or 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:
Returns:
Applies to
Azure SDK for Java