Share via

BatchTaskExecutionInfo Class

Package:
com.azure.compute.batch.models
Maven Artifact:
com.azure:azure-compute-batch:1.0.0-beta.5
  • java.lang.Object
    • com.azure.compute.batch.models.BatchTaskExecutionInfo

Implements

JsonSerializable<BatchTaskExecutionInfo>

public final class BatchTaskExecutionInfo
implements JsonSerializable<BatchTaskExecutionInfo>

Information about the execution of a Task.

Method Summary

Modifier and Type Method and Description
static BatchTaskExecutionInfo fromJson(JsonReader jsonReader)

Reads an instance of BatchTaskExecutionInfo from the JsonReader.
BatchTaskContainerExecutionInfo getContainerInfo()

Get the containerInfo property: Information about the container under which the Task is executing.
OffsetDateTime getEndTime()

Get the endTime property: The time at which the Task completed.
Integer getExitCode()

Get the exitCode property: The exit code of the program specified on the Task command line.
BatchTaskFailureInfo getFailureInfo()

Get the failureInfo property: Information describing the Task failure, if any.
OffsetDateTime getLastRequeueTime()

Get the lastRequeueTime property: The most recent time at which the Task has been requeued by the Batch service as the result of a user request.
OffsetDateTime getLastRetryTime()

Get the lastRetryTime property: The most recent time at which a retry of the Task started running.
int getRequeueCount()

Get the requeueCount property: The number of times the Task has been requeued by the Batch service as the result of a user request.
BatchTaskExecutionResult getResult()

Get the result property: The result of the Task execution.
int getRetryCount()

Get the retryCount property: The number of times the Task has been retried by the Batch service.
OffsetDateTime getStartTime()

Get the startTime property: The time at which the Task started running.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static BatchTaskExecutionInfo fromJson(JsonReader jsonReader)

Reads an instance of BatchTaskExecutionInfo from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of BatchTaskExecutionInfo if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

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.

getEndTime

public OffsetDateTime getEndTime()

Get the endTime property: The time at which the Task completed. This property is set only if the Task is in the Completed state.

Returns:

the endTime value.

getExitCode

public Integer getExitCode()

Get the exitCode property: The exit code of the program specified on the Task command line. This property is set only if the Task is in the completed state. In general, 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. However, if the Batch service terminates the Task (due to timeout, or user termination via the API) you may see an operating system-defined exit code.

Returns:

the exitCode 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.

getLastRequeueTime

public OffsetDateTime getLastRequeueTime()

Get the lastRequeueTime property: The most recent time at which the Task has been requeued by the Batch service as the result of a user request. This property is set only if the requeueCount is nonzero.

Returns:

the lastRequeueTime value.

getLastRetryTime

public OffsetDateTime getLastRetryTime()

Get the lastRetryTime property: The most recent time at which a retry of the Task started running. This element is present 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.

getRequeueCount

public int getRequeueCount()

Get the requeueCount property: The number of times the Task has been requeued by the Batch service as the result of a user request. When the user removes Compute Nodes from a Pool (by resizing/shrinking the pool) or when the Job is being disabled, the user can specify that running Tasks on the Compute Nodes be requeued for execution. This count tracks how many times the Task has been requeued for these reasons.

Returns:

the requeueCount 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.

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.

Returns:

the retryCount value.

getStartTime

public OffsetDateTime getStartTime()

Get the startTime property: The time at which the Task started running. 'Running' corresponds to the running state, so if the Task specifies resource files or Packages, then the start time reflects the time at which the Task started downloading or deploying these. If the Task has been restarted or retried, this is the most recent time at which the Task started running. This property is present only for Tasks that are in the running or completed state.

Returns:

the startTime value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to