JobExecutionInformation Class

Package:

com.microsoft.azure.batch.protocol.models

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

public class JobExecutionInformation

Contains information about the execution of a job in the Azure Batch service.

Method Summary

Modifier and Type	Method and Description
DateTime	endTime() Get this property is set only if the job is in the completed state.
String	poolId() Get this element contains the actual pool where the job is assigned. When you get job details from the service, they also contain a poolInfo element, which contains the pool configuration data from when the job was added or updated. That poolInfo element may also contain a poolId element. If it does, the two IDs are the same. If it does not, it means the job ran on an auto pool, and this property contains the ID of that auto pool.
JobSchedulingError	schedulingError() Get this property is not set if there was no error starting the job.
DateTime	startTime() Get this is the time at which the job was created.
String	terminateReason() Get this property is set only if the job is in the completed state. If the Batch service terminates the job, it sets the reason as follows: JMComplete - the Job Manager task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the job reached its maxWallClockTime constraint. TerminateJobSchedule - the job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the job's onAllTasksComplete attribute is set to terminatejob, and all tasks in the job are complete. TaskFailed - the job's onTaskFailure attribute is set to performExitOptionsJobAction, and a task in the job failed with an exit condition that specified a jobAction of terminatejob. Any other string is a user-defined reason specified in a call to the 'Terminate a job' operation.
JobExecutionInformation	withEndTime(DateTime endTime) Set this property is set only if the job is in the completed state.
JobExecutionInformation	withPoolId(String poolId) Set this element contains the actual pool where the job is assigned. When you get job details from the service, they also contain a poolInfo element, which contains the pool configuration data from when the job was added or updated. That poolInfo element may also contain a poolId element. If it does, the two IDs are the same. If it does not, it means the job ran on an auto pool, and this property contains the ID of that auto pool.
JobExecutionInformation	withSchedulingError(JobSchedulingError schedulingError) Set this property is not set if there was no error starting the job.
JobExecutionInformation	withStartTime(DateTime startTime) Set this is the time at which the job was created.
JobExecutionInformation	withTerminateReason(String terminateReason) Set this property is set only if the job is in the completed state. If the Batch service terminates the job, it sets the reason as follows: JMComplete - the Job Manager task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the job reached its maxWallClockTime constraint. TerminateJobSchedule - the job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the job's onAllTasksComplete attribute is set to terminatejob, and all tasks in the job are complete. TaskFailed - the job's onTaskFailure attribute is set to performExitOptionsJobAction, and a task in the job failed with an exit condition that specified a jobAction of terminatejob. Any other string is a user-defined reason specified in a call to the 'Terminate a job' operation.

Method Details

endTime

public DateTime endTime()

Get this property is set only if the job is in the completed state.

Returns:

the endTime value

poolId

public String poolId()

Get this element contains the actual pool where the job is assigned. When you get job details from the service, they also contain a poolInfo element, which contains the pool configuration data from when the job was added or updated. That poolInfo element may also contain a poolId element. If it does, the two IDs are the same. If it does not, it means the job ran on an auto pool, and this property contains the ID of that auto pool.

Returns:

the poolId value

schedulingError

public JobSchedulingError schedulingError()

Get this property is not set if there was no error starting the job.

Returns:

the schedulingError value

startTime

public DateTime startTime()

Get this is the time at which the job was created.

Returns:

the startTime value

terminateReason

public String terminateReason()

Get this property is set only if the job is in the completed state. If the Batch service terminates the job, it sets the reason as follows: JMComplete - the Job Manager task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the job reached its maxWallClockTime constraint. TerminateJobSchedule - the job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the job's onAllTasksComplete attribute is set to terminatejob, and all tasks in the job are complete. TaskFailed - the job's onTaskFailure attribute is set to performExitOptionsJobAction, and a task in the job failed with an exit condition that specified a jobAction of terminatejob. Any other string is a user-defined reason specified in a call to the 'Terminate a job' operation.

Returns:

the terminateReason value

withEndTime

public JobExecutionInformation withEndTime(DateTime endTime)

Set this property is set only if the job is in the completed state.

Parameters:

endTime - the endTime value to set

Returns:

the JobExecutionInformation object itself.

withPoolId

public JobExecutionInformation withPoolId(String poolId)

Set this element contains the actual pool where the job is assigned. When you get job details from the service, they also contain a poolInfo element, which contains the pool configuration data from when the job was added or updated. That poolInfo element may also contain a poolId element. If it does, the two IDs are the same. If it does not, it means the job ran on an auto pool, and this property contains the ID of that auto pool.

Parameters:

poolId - the poolId value to set

Returns:

the JobExecutionInformation object itself.

withSchedulingError

public JobExecutionInformation withSchedulingError(JobSchedulingError schedulingError)

Set this property is not set if there was no error starting the job.

Parameters:

schedulingError - the schedulingError value to set

Returns:

the JobExecutionInformation object itself.

withStartTime

public JobExecutionInformation withStartTime(DateTime startTime)

Set this is the time at which the job was created.

Parameters:

startTime - the startTime value to set

Returns:

the JobExecutionInformation object itself.

withTerminateReason

public JobExecutionInformation withTerminateReason(String terminateReason)

Set this property is set only if the job is in the completed state. If the Batch service terminates the job, it sets the reason as follows: JMComplete - the Job Manager task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the job reached its maxWallClockTime constraint. TerminateJobSchedule - the job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the job's onAllTasksComplete attribute is set to terminatejob, and all tasks in the job are complete. TaskFailed - the job's onTaskFailure attribute is set to performExitOptionsJobAction, and a task in the job failed with an exit condition that specified a jobAction of terminatejob. Any other string is a user-defined reason specified in a call to the 'Terminate a job' operation.

Parameters:

terminateReason - the terminateReason value to set

Returns:

the JobExecutionInformation object itself.