Job Job Job Class

Definition

Represents a command running in background. A job object can internally contain many child job objects.

public abstract class Job : IDisposable
type Job = class
    interface IDisposable
Public MustInherit Class Job
Implements IDisposable
Inheritance
Derived
Implements

Constructors

Job() Job() Job()

Default constructor

Job(String) Job(String) Job(String)

Creates an instance of this class

Job(String, String) Job(String, String) Job(String, String)

Creates an instance of this class

Job(String, String, IList<Job>) Job(String, String, IList<Job>) Job(String, String, IList<Job>)

Creates an instance of this class

Job(String, String, Guid) Job(String, String, Guid) Job(String, String, Guid)

Creates an instance of this class

Job(String, String, JobIdentifier) Job(String, String, JobIdentifier) Job(String, String, JobIdentifier)

Creates an instance of this class

Properties

ChildJobs ChildJobs ChildJobs

List of child jobs contained within this job

Command Command Command

Command Invoked by this Job

Debug Debug Debug

Gets or sets the debug buffer. Debug output of Job is written to this buffer. Cannot set to a null value.

Error Error Error

Gets or sets the error buffer. Errors of job are written into this buffer.

Finished Finished Finished

Wait Handle which is signaled when job is finished. This is set when state of the job is set to Completed, Stopped or Failed.

HasMoreData HasMoreData HasMoreData

Indicates that more data is available in this result object for reading.

Id Id Id

Short identifier for this result which will be recycled and used within a process

Information Information Information

Gets or sets the information buffer. Information records of job are written to this buffer

InstanceId InstanceId InstanceId

unique identifier for this job

JobStateInfo JobStateInfo JobStateInfo

Status of the command execution.

Location Location Location

Indicates a location where this job is running

Name Name Name

Name for identifying this job object

Output Output Output

Gets or sets the output buffer. Output of job is written into this buffer.

Progress Progress Progress

Gets or sets the progress buffer. Progress of job is written into this buffer.

PSBeginTime PSBeginTime PSBeginTime

Time job was started.

PSEndTime PSEndTime PSEndTime

Time job stopped.

PSJobTypeName PSJobTypeName PSJobTypeName

Job type name.

StatusMessage StatusMessage StatusMessage

Success status of the command execution.

Verbose Verbose Verbose

Gets or sets the verbose buffer. Verbose output of job is written to this stream.

Warning Warning Warning

Gets or sets the warning buffer. Warnings of job are written to this buffer

Methods

AutoGenerateJobName() AutoGenerateJobName() AutoGenerateJobName()

Automatically generate a job name if the user does not supply one

Dispose() Dispose() Dispose()

Dispose all managed resources. This will suppress finalizer on the object from getting called by calling System.GC.SuppressFinalize(this).

Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

Release all the resources.

DoLoadJobStreams() DoLoadJobStreams() DoLoadJobStreams()

This method is introduce for delaying the loading of streams for a particular job.

DoUnloadJobStreams() DoUnloadJobStreams() DoUnloadJobStreams()

Unloads job streams information. Enables jobs to clear stream information from memory

LoadJobStreams() LoadJobStreams() LoadJobStreams()

Load the required job streams

SetJobState(JobState) SetJobState(JobState) SetJobState(JobState)

Sets Job State.

StopJob() StopJob() StopJob()

Stop this job object. If job contains child job, this should stop child job objects also.

UnloadJobStreams() UnloadJobStreams() UnloadJobStreams()

Unload the required job streams

Events

StateChanged StateChanged StateChanged

Event raised when state of the job changes

Applies to