BatchStartTaskInfo Class

Definition

Namespace:

Azure.Compute.Batch

Assembly:

Azure.Compute.Batch.dll

Package:

Azure.Compute.Batch v1.0.0-beta.1

Source:

BatchStartTaskInfo.cs

Information about a StartTask running on a Compute Node.

public class BatchStartTaskInfo : System.ClientModel.Primitives.IJsonModel<Azure.Compute.Batch.BatchStartTaskInfo>, System.ClientModel.Primitives.IPersistableModel<Azure.Compute.Batch.BatchStartTaskInfo>

type BatchStartTaskInfo = class
    interface IJsonModel<BatchStartTaskInfo>
    interface IPersistableModel<BatchStartTaskInfo>

Public Class BatchStartTaskInfo
Implements IJsonModel(Of BatchStartTaskInfo), IPersistableModel(Of BatchStartTaskInfo)

Inheritance

Object

BatchStartTaskInfo

Implements

IJsonModel<BatchStartTaskInfo> IPersistableModel<BatchStartTaskInfo> IPersistableModel<T>

Properties

ContainerInfo	Information about the container under which the Task is executing. This property is set only if the Task runs in a container context.
EndTime	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.
ExitCode	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.
FailureInfo	Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure.
LastRetryTime	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.
Result	The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property.
RetryCount	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.
StartTime	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).
State	The state of the StartTask on the Compute Node.

Explicit Interface Implementations

IJsonModel<BatchStartTaskInfo>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<BatchStartTaskInfo>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<BatchStartTaskInfo>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<BatchStartTaskInfo>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<BatchStartTaskInfo>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.