BatchTaskConstraints Class

Definition

Namespace:

Azure.Compute.Batch

Assembly:

Azure.Compute.Batch.dll

Package:

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

Source:

BatchTaskConstraints.cs

Execution constraints to apply to a Task.

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

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

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

Inheritance

Object

BatchTaskConstraints

Implements

IJsonModel<BatchTaskConstraints> IPersistableModel<BatchTaskConstraints> IPersistableModel<T>

Constructors

BatchTaskConstraints()

Initializes a new instance of BatchTaskConstraints.

Properties

MaxTaskRetryCount	The maximum number of times the Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries for the Task executable due to a nonzero exit code. The Batch service will try the Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the Task after the first attempt. If the maximum retry count is -1, the Batch service retries the Task without limit, however this is not recommended for a start task or any task. The default value is 0 (no retries).
MaxWallClockTime	The maximum elapsed time that the Task may run, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it. If this is not specified, there is no time limit on how long the Task may run.
RetentionTime	The minimum time to retain the Task directory on the Compute Node where it ran, from the time it completes execution. After this time, the Batch service may delete the Task directory and all its contents. The default is 7 days, i.e. the Task directory will be retained for 7 days unless the Compute Node is removed or the Job is deleted.

Explicit Interface Implementations

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