Package com.azure.compute.batch.models

Class BatchJobPreparationTaskExecutionInfo

java.lang.Object
com.azure.compute.batch.models.BatchJobPreparationTaskExecutionInfo
All Implemented Interfaces:
com.azure.json.JsonSerializable<BatchJobPreparationTaskExecutionInfo>
public final class BatchJobPreparationTaskExecutionInfo extends Object implements com.azure.json.JsonSerializable<BatchJobPreparationTaskExecutionInfo>
Contains information about the execution of a Job Preparation Task on a Compute Node.

  • Method Details

    • getStartTime

      public OffsetDateTime getStartTime()
      Get the startTime property: The time at which the Task started running. If the Task has been restarted or retried, this is the most recent time at which the Task started running.
      Returns:
      the startTime value.

    • getEndTime

      public OffsetDateTime getEndTime()
      Get the endTime property: The time at which the Job Preparation Task completed. This property is set only if the Task is in the Completed state.
      Returns:
      the endTime value.

    • getState

      public BatchJobPreparationTaskState getState()
      Get the state property: The current state of the Job Preparation Task on the Compute Node.
      Returns:
      the state value.

    • getTaskRootDirectory

      public String getTaskRootDirectory()
      Get the taskRootDirectory property: The root directory of the Job Preparation Task on the Compute Node. You can use this path to retrieve files created by the Task, such as log files.
      Returns:
      the taskRootDirectory value.

    • getTaskRootDirectoryUrl

      public String getTaskRootDirectoryUrl()
      Get the taskRootDirectoryUrl property: The URL to the root directory of the Job Preparation Task on the Compute Node.
      Returns:
      the taskRootDirectoryUrl value.

    • getExitCode

      public Integer getExitCode()
      Get the exitCode property: The exit code of the program specified on the Task command line. 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.

    • getContainerInfo

      public BatchTaskContainerExecutionInfo getContainerInfo()
      Get the containerInfo property: Information about the container under which the Task is executing. This property is set only if the Task runs in a container context.
      Returns:
      the containerInfo value.

    • getFailureInfo

      public BatchTaskFailureInfo getFailureInfo()
      Get the failureInfo property: Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure.
      Returns:
      the failureInfo value.

    • getRetryCount

      public int getRetryCount()
      Get the retryCount property: The number of times the Task has been retried by the Batch service. 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. 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.

    • getLastRetryTime

      public OffsetDateTime getLastRetryTime()
      Get the lastRetryTime property: The most recent time at which a retry of the Job Preparation Task started running. 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.

    • getResult

      public BatchTaskExecutionResult getResult()
      Get the result property: The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property.
      Returns:
      the result value.

    • toJson

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

    • fromJson

      public static BatchJobPreparationTaskExecutionInfo fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of BatchJobPreparationTaskExecutionInfo from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of BatchJobPreparationTaskExecutionInfo 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 BatchJobPreparationTaskExecutionInfo.