ComputeBatchModelFactory.BatchTaskExecutionInfo 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 BatchTaskExecutionInfo.

public static Azure.Compute.Batch.BatchTaskExecutionInfo BatchTaskExecutionInfo (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, int requeueCount = 0, DateTimeOffset? lastRequeueTime = default, Azure.Compute.Batch.BatchTaskExecutionResult? result = default);

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

Public Shared Function BatchTaskExecutionInfo (Optional startTime As Nullable(Of 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 requeueCount As Integer = 0, Optional lastRequeueTime As Nullable(Of DateTimeOffset) = Nothing, Optional result As Nullable(Of BatchTaskExecutionResult) = Nothing) As BatchTaskExecutionInfo

Parameters

startTime

Nullable<DateTimeOffset>

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.

endTime

Nullable<DateTimeOffset>

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

exitCode

Nullable<Int32>

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.

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.

requeueCount

Int32

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.

lastRequeueTime

Nullable<DateTimeOffset>

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.

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

BatchTaskExecutionInfo

A new BatchTaskExecutionInfo instance for mocking.