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

public static Azure.Compute.Batch.BatchJobPreparationTaskExecutionInfo BatchJobPreparationTaskExecutionInfo (DateTimeOffset startTime = default, DateTimeOffset? endTime = default, Azure.Compute.Batch.BatchJobPreparationTaskState state = default, string taskRootDirectory = default, string taskRootDirectoryUrl = 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 BatchJobPreparationTaskExecutionInfo : DateTimeOffset * Nullable<DateTimeOffset> * Azure.Compute.Batch.BatchJobPreparationTaskState * string * string * Nullable<int> * Azure.Compute.Batch.BatchTaskContainerExecutionInfo * Azure.Compute.Batch.BatchTaskFailureInfo * int * Nullable<DateTimeOffset> * Nullable<Azure.Compute.Batch.BatchTaskExecutionResult> -> Azure.Compute.Batch.BatchJobPreparationTaskExecutionInfo

Public Shared Function BatchJobPreparationTaskExecutionInfo (Optional startTime As DateTimeOffset = Nothing, Optional endTime As Nullable(Of DateTimeOffset) = Nothing, Optional state As BatchJobPreparationTaskState = Nothing, Optional taskRootDirectory As String = Nothing, Optional taskRootDirectoryUrl As String = 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 BatchJobPreparationTaskExecutionInfo

Parameters

startTime

DateTimeOffset

The time at which the Task started running. If the Task has been restarted or retried, this is the most recent time at which the Task started running.

endTime

Nullable<DateTimeOffset>

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

state

BatchJobPreparationTaskState

The current state of the Job Preparation Task on the Compute Node.

taskRootDirectory

String

The root directory of the Job Preparation Task on the Compute Node. You can use this path to retrieve files created by the Task, such as log files.

taskRootDirectoryUrl

String

The URL to the root directory of the Job Preparation Task on the Compute Node.

exitCode

Nullable<Int32>

The exit code of the program specified on the Task command line. This parameter is returned only if the Task is in the completed state. 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. Note that the exit code may also be generated by the Compute Node operating system, such as when a process is forcibly terminated.

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. 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 Job Preparation Task started running. This property is set 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

BatchJobPreparationTaskExecutionInfo

A new BatchJobPreparationTaskExecutionInfo instance for mocking.