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

Class JobPreparationTaskExecutionInformation

  • public class JobPreparationTaskExecutionInformation
extends Object
    Contains information about the execution of a Job Preparation Task on a Compute Node.

    • Constructor Detail

      • JobPreparationTaskExecutionInformation

        public JobPreparationTaskExecutionInformation()

    • Method Detail

      • startTime

        public org.joda.time.DateTime startTime()
        Get if the Task has been restarted or retried, this is the most recent time at which the Task started running.
        Returns:
        the startTime value

      • withStartTime

        public JobPreparationTaskExecutionInformation withStartTime​(org.joda.time.DateTime startTime)
        Set if the Task has been restarted or retried, this is the most recent time at which the Task started running.
        Parameters:
        startTime - the startTime value to set
        Returns:
        the JobPreparationTaskExecutionInformation 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 JobPreparationTaskExecutionInformation 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 JobPreparationTaskExecutionInformation object itself.

      • state

        public JobPreparationTaskState state()
        Get possible values include: 'running', 'completed'.
        Returns:
        the state value

      • taskRootDirectory

        public String taskRootDirectory()
        Get the taskRootDirectory value.
        Returns:
        the taskRootDirectory value

      • withTaskRootDirectory

        public JobPreparationTaskExecutionInformation withTaskRootDirectory​(String taskRootDirectory)
        Set the taskRootDirectory value.
        Parameters:
        taskRootDirectory - the taskRootDirectory value to set
        Returns:
        the JobPreparationTaskExecutionInformation object itself.

      • taskRootDirectoryUrl

        public String taskRootDirectoryUrl()
        Get the taskRootDirectoryUrl value.
        Returns:
        the taskRootDirectoryUrl value

      • withTaskRootDirectoryUrl

        public JobPreparationTaskExecutionInformation withTaskRootDirectoryUrl​(String taskRootDirectoryUrl)
        Set the taskRootDirectoryUrl value.
        Parameters:
        taskRootDirectoryUrl - the taskRootDirectoryUrl value to set
        Returns:
        the JobPreparationTaskExecutionInformation object itself.

      • exitCode

        public Integer exitCode()
        Get 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.
        Returns:
        the exitCode value

      • withExitCode

        public JobPreparationTaskExecutionInformation withExitCode​(Integer exitCode)
        Set 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.
        Parameters:
        exitCode - the exitCode value to set
        Returns:
        the JobPreparationTaskExecutionInformation object itself.

      • containerInfo

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

      • withFailureInfo

        public JobPreparationTaskExecutionInformation 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 JobPreparationTaskExecutionInformation 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 JobPreparationTaskExecutionInformation 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 JobPreparationTaskExecutionInformation object itself.

      • lastRetryTime

        public org.joda.time.DateTime lastRetryTime()
        Get 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.
        Returns:
        the lastRetryTime value

      • withLastRetryTime

        public JobPreparationTaskExecutionInformation withLastRetryTime​(org.joda.time.DateTime lastRetryTime)
        Set 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.
        Parameters:
        lastRetryTime - the lastRetryTime value to set
        Returns:
        the JobPreparationTaskExecutionInformation 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 JobPreparationTaskExecutionInformation 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 JobPreparationTaskExecutionInformation object itself.