JobReleaseTaskExecutionInformation Class

Package:

com.microsoft.azure.batch.protocol.models

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

public class JobReleaseTaskExecutionInformation

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

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

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 JobReleaseTaskState 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 JobReleaseTaskExecutionInformation 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 JobReleaseTaskExecutionInformation object itself.

withEndTime

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

withExitCode

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

withFailureInfo

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

withResult

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

withStartTime

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

withState

public JobReleaseTaskExecutionInformation withState(JobReleaseTaskState state)

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

Parameters:

state - the state value to set

Returns:

the JobReleaseTaskExecutionInformation object itself.

withTaskRootDirectory

public JobReleaseTaskExecutionInformation withTaskRootDirectory(String taskRootDirectory)

Set the taskRootDirectory value.

Parameters:

taskRootDirectory - the taskRootDirectory value to set

Returns:

the JobReleaseTaskExecutionInformation object itself.

withTaskRootDirectoryUrl

public JobReleaseTaskExecutionInformation withTaskRootDirectoryUrl(String taskRootDirectoryUrl)

Set the taskRootDirectoryUrl value.

Parameters:

taskRootDirectoryUrl - the taskRootDirectoryUrl value to set

Returns:

the JobReleaseTaskExecutionInformation object itself.