The Job type exposes the following members.

Constructors

  Name Description
Public method Job
Initializes a new instance of the Job class.

Methods

  Name Description
Public method AddTask
Adds a task to Job.
Public method Cancel()()()()
Cancels all tasks in this job. Will not listen for cancellation events.
Public method Cancel(Boolean)
Cancels all tasks in this job.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Submit
Submits job to job scheduler.
Public method ToString (Inherited from Object.)
Public method WaitUntilDone()()()()
Blocks until all tasks in this job complete.
Public method WaitUntilDone(Int32)
Blocks until all tasks in this job complete or the operation times out.
Public method WaitUntilDone(Int32, Action, Int32)
Blocks until all tasks in this job complete or the operation times out. The callback passed in for the heartbeat is called with the period specified by the millisecondsHeartbeat argument.

Properties

  Name Description
Public property AdditionalDependencies
Gets the additional dependency that are sent with the Job.
Public property AgentSelectionPreference
Gets or sets the agent selection preference.
Public property CancelOnClientDisconnection
Gets or sets a value indicating whether to cancel the tasks of this Job when the client disconnects.
Public property CancelOnTaskFailure
Gets or sets a value indicating whether to cancel other tasks on this Job if another Task fails.
Public property Description
Gets or sets the Job description.
Public property ExcludedDependencies
Gets the excluded assemblies that are not sent with the Job.
Public property ExclusiveExecution
Gets or sets a value indicating whether the tasks on this job should have exclusive access to the resource it is running on.
Public property FailIfPreconditionsNotSatisfied
Gets or sets a value indicating whether to fail all tasks immediately of this Job if the precondition is not satisfied.
Public property Id
Gets the job's id.
Public property IsCanceled
Gets a value indicating whether this job has been canceled.
Public property MaxTaskInterruptedRetryAttempts
Gets or sets the maximum number of times a task will be retried if it is interrupted.
Public property MinimizeClientMessaging
Gets or sets a value indicating whether to minimize sending some messages from the Coordinator. If set to true, some events may not fire.
Public property Name
Gets or sets the Job name.
Public property Priority
Gets or sets the job priority.
Public property RaiseEventsUsingSynchronizationContext
Gets or sets a value indicating whether Job and Task events such as JobCompleted are raised using the SynchronizationContext of the thread that submits the job. If this property is falseFalsefalsefalse (False in Visual Basic), no events are raised until WaitUntilDone()()()() is called, at which point the events are raised in the thread that calls it. If this property is trueTruetruetrue (True in Visual Basic), events are raised by posting them to the SynchronizationContext of the thread that calls Submit()()()(), no matter if WaitUntilDone()()()() is called or not.
Public property TaskEnvironment
Gets or sets Job's TaskEnvironment
Public property TaskExecutionTimeout
Gets or sets the timeout for task execution in milliseconds.
Public property TaskPreconditions
Gets the list of task pre conditions.
Public property Tasks
Gets the tasks that are contained in this Job.

Events

  Name Description
Public event JobCompleted
Occurs when all tasks of a Job is completed.
Public event JobSubmitted
Occurs when Job is submitted.
Public event TaskCompleted
Occurs when Task is completed.
Public event TaskProgressUpdated
Occurs when Task progress changes.
Public event TaskStateChanged
Occurs when Task status changes.

See Also