JobPreparationTaskExecutionInformation Class

Package:

com.microsoft.azure.batch.protocol.models

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

public class JobPreparationTaskExecutionInformation

Contains information about the execution of a Job Preparation task on a compute node.

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 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.
TaskFailureInformation	failureInfo() Get this property is set only if the task is in the completed state and encountered a failure.
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.
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 if the task has been restarted or retried, this is the most recent time at which the task started running.
JobPreparationTaskState	state() Get possible values include: 'running', 'completed'.
String	taskRootDirectory() Get the taskRootDirectory value.
String	taskRootDirectoryUrl() Get the taskRootDirectoryUrl value.
JobPreparationTaskExecutionInformation	withContainerInfo(TaskContainerExecutionInformation containerInfo) Set this property is set only if the task runs in a container context.
JobPreparationTaskExecutionInformation	withEndTime(DateTime endTime) Set this property is set only if the task is in the Completed state.
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.
JobPreparationTaskExecutionInformation	withFailureInfo(TaskFailureInformation failureInfo) Set this property is set only if the task is in the completed state and encountered a failure.
JobPreparationTaskExecutionInformation	withLastRetryTime(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.
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'.
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.
JobPreparationTaskExecutionInformation	withStartTime(DateTime startTime) Set if the task has been restarted or retried, this is the most recent time at which the task started running.
JobPreparationTaskExecutionInformation	withState(JobPreparationTaskState state) Set possible values include: 'running', 'completed'.
JobPreparationTaskExecutionInformation	withTaskRootDirectory(String taskRootDirectory) Set the taskRootDirectory value.
JobPreparationTaskExecutionInformation	withTaskRootDirectoryUrl(String taskRootDirectoryUrl) Set the taskRootDirectoryUrl value.

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

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

lastRetryTime

public 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

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 if the task has been restarted or retried, this is the most recent time at which the task started running.

Returns:

the startTime value

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

taskRootDirectoryUrl

public String taskRootDirectoryUrl()

Get the taskRootDirectoryUrl value.

Returns:

the taskRootDirectoryUrl value

withContainerInfo

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

withEndTime

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

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.

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.

withLastRetryTime

public JobPreparationTaskExecutionInformation withLastRetryTime(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.

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.

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.

withStartTime

public JobPreparationTaskExecutionInformation withStartTime(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.

withState

public JobPreparationTaskExecutionInformation withState(JobPreparationTaskState state)

Set possible values include: 'running', 'completed'.

Parameters:

state - the state value to set

Returns:

the JobPreparationTaskExecutionInformation object itself.

withTaskRootDirectory

public JobPreparationTaskExecutionInformation withTaskRootDirectory(String taskRootDirectory)

Set the taskRootDirectory value.

Parameters:

taskRootDirectory - the taskRootDirectory value to set

Returns:

the JobPreparationTaskExecutionInformation object itself.

withTaskRootDirectoryUrl

public JobPreparationTaskExecutionInformation withTaskRootDirectoryUrl(String taskRootDirectoryUrl)

Set the taskRootDirectoryUrl value.

Parameters:

taskRootDirectoryUrl - the taskRootDirectoryUrl value to set

Returns:

the JobPreparationTaskExecutionInformation object itself.