ComputeBatchModelFactory.BatchStartTaskInfo Method

Definition

Namespace:

Azure.Compute.Batch

Assembly:

Azure.Compute.Batch.dll

Package:

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

Source:

ComputeBatchModelFactory.cs

Initializes a new instance of BatchStartTaskInfo.

public static Azure.Compute.Batch.BatchStartTaskInfo BatchStartTaskInfo (Azure.Compute.Batch.BatchStartTaskState state = default, DateTimeOffset startTime = default, DateTimeOffset? endTime = default, int? exitCode = default, Azure.Compute.Batch.BatchTaskContainerExecutionInfo containerInfo = default, Azure.Compute.Batch.BatchTaskFailureInfo failureInfo = default, int retryCount = 0, DateTimeOffset? lastRetryTime = default, Azure.Compute.Batch.BatchTaskExecutionResult? result = default);

static member BatchStartTaskInfo : Azure.Compute.Batch.BatchStartTaskState * DateTimeOffset * Nullable<DateTimeOffset> * Nullable<int> * Azure.Compute.Batch.BatchTaskContainerExecutionInfo * Azure.Compute.Batch.BatchTaskFailureInfo * int * Nullable<DateTimeOffset> * Nullable<Azure.Compute.Batch.BatchTaskExecutionResult> -> Azure.Compute.Batch.BatchStartTaskInfo

Public Shared Function BatchStartTaskInfo (Optional state As BatchStartTaskState = Nothing, Optional startTime As DateTimeOffset = Nothing, Optional endTime As Nullable(Of DateTimeOffset) = Nothing, Optional exitCode As Nullable(Of Integer) = Nothing, Optional containerInfo As BatchTaskContainerExecutionInfo = Nothing, Optional failureInfo As BatchTaskFailureInfo = Nothing, Optional retryCount As Integer = 0, Optional lastRetryTime As Nullable(Of DateTimeOffset) = Nothing, Optional result As Nullable(Of BatchTaskExecutionResult) = Nothing) As BatchStartTaskInfo

Parameters

state

BatchStartTaskState

The state of the StartTask on the Compute Node.

startTime

DateTimeOffset

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

endTime

Nullable<DateTimeOffset>

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

Nullable<Int32>

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.

containerInfo

BatchTaskContainerExecutionInfo

Information about the container under which the Task is executing. This property is set only if the Task runs in a container context.

failureInfo

BatchTaskFailureInfo

Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure.

retryCount

Int32

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.

lastRetryTime

Nullable<DateTimeOffset>

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

Nullable<BatchTaskExecutionResult>

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

BatchStartTaskInfo

A new BatchStartTaskInfo instance for mocking.