JobReleaseTask Class

Definition

A Job Release Task to run on Job completion on any Compute Node where the Job has run.

public class JobReleaseTask
type JobReleaseTask = class
Public Class JobReleaseTask
Inheritance
JobReleaseTask

Remarks

The Job Release Task runs when the Job ends, because of one of the following: The user calls the Terminate Job API, or the Delete Job API while the Job is still active, the Job's maximum wall clock time constraint is reached, and the Job is still active, or the Job's Job Manager Task completed, and the Job is configured to terminate when the Job Manager completes. The Job Release Task runs on each Node where Tasks of the Job have run and the Job Preparation Task ran and completed. If you reimage a Node after it has run the Job Preparation Task, and the Job ends without any further Tasks of the Job running on that Node (and hence the Job Preparation Task does not re-run), then the Job Release Task does not run on that Compute Node. If a Node reboots while the Job Release Task is still running, the Job Release Task runs again when the Compute Node starts up. The Job is not marked as complete until all Job Release Tasks have completed. The Job Release Task runs in the background. It does not occupy a scheduling slot; that is, it does not count towards the taskSlotsPerNode limit specified on the Pool.

Constructors

JobReleaseTask()

Initializes a new instance of the JobReleaseTask class.

JobReleaseTask(String, String, TaskContainerSettings, IList<ResourceFile>, IList<EnvironmentSetting>, Nullable<TimeSpan>, Nullable<TimeSpan>, UserIdentity)

Initializes a new instance of the JobReleaseTask class.

Properties

CommandLine

Gets or sets the command line of the Job Release Task.

ContainerSettings

Gets or sets the settings for the container under which the Job Release Task runs.

EnvironmentSettings

Gets or sets a list of environment variable settings for the Job Release Task.

Id

Gets or sets a string that uniquely identifies the Job Release Task within the Job.

MaxWallClockTime

Gets or sets the maximum elapsed time that the Job Release Task may run on a given Compute Node, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it. The default value is 15 minutes. You may not specify a timeout longer than 15 minutes. If you do, the Batch service rejects it with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

ResourceFiles

Gets or sets a list of files that the Batch service will download to the Compute Node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.

RetentionTime

Gets or sets the minimum time to retain the Task directory for the Job Release Task on the Compute Node. After this time, the Batch service may delete the Task directory and all its contents.

UserIdentity

Gets or sets the user identity under which the Job Release Task runs.

Applies to