Package com.microsoft.azure.batch.protocol.models

Class TaskExecutionInformation

  • public class TaskExecutionInformation
extends Object
    Information about the execution of a Task.

    • Constructor Detail

      • TaskExecutionInformation

        public TaskExecutionInformation()

    • Method Detail

      • startTime

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

      • withStartTime

        public TaskExecutionInformation withStartTime​(org.joda.time.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:
        startTime - the startTime value to set
        Returns:
        the TaskExecutionInformation object itself.

      • endTime

        public org.joda.time.DateTime endTime()
        Get this property is set only if the Task is in the Completed state.
        Returns:
        the endTime value

      • withEndTime

        public TaskExecutionInformation withEndTime​(org.joda.time.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.

      • 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

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

      • containerInfo

        public TaskContainerExecutionInformation containerInfo()
        Get this property is set only if the Task runs in a container context.
        Returns:
        the containerInfo 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.

      • 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

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

      • 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

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

      • lastRetryTime

        public org.joda.time.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

      • withLastRetryTime

        public TaskExecutionInformation withLastRetryTime​(org.joda.time.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.

      • 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:
        the requeueCount value

      • 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:
        requeueCount - the requeueCount value to set
        Returns:
        the TaskExecutionInformation object itself.

      • lastRequeueTime

        public org.joda.time.DateTime lastRequeueTime()
        Get this property is set only if the requeueCount is nonzero.
        Returns:
        the lastRequeueTime value

      • withLastRequeueTime

        public TaskExecutionInformation withLastRequeueTime​(org.joda.time.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.

      • 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

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