BatchStartTaskInfo 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.BatchStartTaskInfo

Implements

JsonSerializable<BatchStartTaskInfo>

public final class BatchStartTaskInfo
implements JsonSerializable<BatchStartTaskInfo>

Information about a StartTask running on a Compute Node.

Method Summary

Modifier and Type	Method and Description
static BatchStartTaskInfo	fromJson(JsonReader jsonReader) Reads an instance of BatchStartTaskInfo 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 StartTask stopped running.
Integer	getExitCode() Get the exitCode property: The exit code of the program specified on the StartTask command line.
BatchTaskFailureInfo	getFailureInfo() Get the failureInfo property: Information describing the Task failure, if any.
OffsetDateTime	getLastRetryTime() Get the lastRetryTime property: The most recent time at which a retry of the Task started running.
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 StartTask started running.
BatchStartTaskState	getState() Get the state property: The state of the StartTask on the Compute Node.
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 BatchStartTaskInfo fromJson(JsonReader jsonReader)

Reads an instance of BatchStartTaskInfo from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of BatchStartTaskInfo 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 StartTask stopped running. This is the end time of the most recent run of the StartTask, if that run has completed (even if that run failed and a retry is pending). This element is not present if the StartTask is currently running.

Returns:

the endTime value.

getExitCode

public Integer getExitCode()

Get the exitCode property: The exit code of the program specified on the StartTask command line. This property is set only if the StartTask 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 StartTask (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.

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.

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 StartTask started running. This value is reset every time the Task is restarted or retried (that is, this is the most recent time at which the StartTask started running).

Returns:

the startTime value.

getState

public BatchStartTaskState getState()

Get the state property: The state of the StartTask on the Compute Node.

Returns:

the state value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException