Package com.azure.compute.batch.models

Class BatchJobExecutionInfo

java.lang.Object
com.azure.compute.batch.models.BatchJobExecutionInfo
All Implemented Interfaces:
com.azure.json.JsonSerializable<BatchJobExecutionInfo>
public final class BatchJobExecutionInfo extends Object implements com.azure.json.JsonSerializable<BatchJobExecutionInfo>
Contains information about the execution of a Job in the Azure Batch service.

  • Method Details

    • getStartTime

      public OffsetDateTime getStartTime()
      Get the startTime property: The start time of the Job. This is the time at which the Job was created.
      Returns:
      the startTime value.

    • getEndTime

      public OffsetDateTime getEndTime()
      Get the endTime property: The completion time of the Job. This property is set only if the Job is in the completed state.
      Returns:
      the endTime value.

    • getPoolId

      public String getPoolId()
      Get the poolId property: The ID of the Pool to which this Job is assigned. 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.

    • getSchedulingError

      public BatchJobSchedulingError getSchedulingError()
      Get the schedulingError property: Details of any error encountered by the service in starting the Job. This property is not set if there was no error starting the Job.
      Returns:
      the schedulingError value.

    • getTerminationReason

      public String getTerminationReason()
      Get the terminationReason property: A string describing the reason the Job ended. 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 terminationReason value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<BatchJobExecutionInfo>
      Throws:
      IOException

    • fromJson

      public static BatchJobExecutionInfo fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of BatchJobExecutionInfo from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of BatchJobExecutionInfo if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the BatchJobExecutionInfo.