Partager via


BatchJobPreparationTaskExecutionInfo Class

Definition

Contains information about the execution of a Job Preparation Task on a Compute Node.

public class BatchJobPreparationTaskExecutionInfo : System.ClientModel.Primitives.IJsonModel<Azure.Compute.Batch.BatchJobPreparationTaskExecutionInfo>, System.ClientModel.Primitives.IPersistableModel<Azure.Compute.Batch.BatchJobPreparationTaskExecutionInfo>
type BatchJobPreparationTaskExecutionInfo = class
    interface IJsonModel<BatchJobPreparationTaskExecutionInfo>
    interface IPersistableModel<BatchJobPreparationTaskExecutionInfo>
Public Class BatchJobPreparationTaskExecutionInfo
Implements IJsonModel(Of BatchJobPreparationTaskExecutionInfo), IPersistableModel(Of BatchJobPreparationTaskExecutionInfo)
Inheritance
BatchJobPreparationTaskExecutionInfo
Implements

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 Job Preparation Task completed. This property is set only if the Task is in the Completed state.

ExitCode

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.

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

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. 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 Task started running. If the Task has been restarted or retried, this is the most recent time at which the Task started running.

State

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

TaskRootDirectory

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

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

Explicit Interface Implementations

IJsonModel<BatchJobPreparationTaskExecutionInfo>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<BatchJobPreparationTaskExecutionInfo>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<BatchJobPreparationTaskExecutionInfo>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<BatchJobPreparationTaskExecutionInfo>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<BatchJobPreparationTaskExecutionInfo>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to