PSEventJob Class

Definition

Namespace:

System.Management.Automation

Assembly:

System.Management.Automation.dll

Package:

System.Management.Automation v7.4.0

A class to give a job-like interface to event actions.

public ref class PSEventJob : System::Management::Automation::Job

public class PSEventJob : System.Management.Automation.Job

type PSEventJob = class
    inherit Job

Public Class PSEventJob
Inherits Job

Inheritance

Object

Job

PSEventJob

Constructors

PSEventJob(PSEventManager, PSEventSubscriber, ScriptBlock, String)

Creates a new instance of the PSEventJob class.

Properties

ChildJobs	List of child jobs contained within this job. (Inherited from Job)
Command	Command Invoked by this Job. (Inherited from Job)
Debug	Gets or sets the debug buffer. Debug output of Job is written to this buffer. Cannot set to a null value. (Inherited from Job)
Error	Gets or sets the error buffer. Errors of job are written into this buffer. (Inherited from Job)
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. (Inherited from Job)
HasMoreData	Indicates if more data is available.
Id	Short identifier for this result which will be recycled and used within a process. (Inherited from Job)
Information	Gets or sets the information buffer. Information records of job are written to this buffer. (Inherited from Job)
InstanceId	Unique identifier for this job. (Inherited from Job)
JobStateInfo	Status of the command execution. (Inherited from Job)
Location	Location in which this job is running.
Module	Gets dynamic module where the action is invoked.
Name	Name for identifying this job object. (Inherited from Job)
Output	Gets or sets the output buffer. Output of job is written into this buffer. (Inherited from Job)
Progress	Gets or sets the progress buffer. Progress of job is written into this buffer. (Inherited from Job)
PSBeginTime	Time job was started. (Inherited from Job)
PSEndTime	Time job stopped. (Inherited from Job)
PSJobTypeName	Job type name. (Inherited from Job)
StatusMessage	Message indicating status of the job.
Verbose	Gets or sets the verbose buffer. Verbose output of job is written to this stream. (Inherited from Job)
Warning	Gets or sets the warning buffer. Warnings of job are written to this buffer. (Inherited from Job)

Methods

AutoGenerateJobName()	Automatically generate a job name if the user does not supply one. (Inherited from Job)
Dispose()	Dispose all managed resources. This will suppress finalizer on the object from getting called by calling System.GC.SuppressFinalize(this). (Inherited from Job)
Dispose(Boolean)	Release all the resources. (Inherited from Job)
DoLoadJobStreams()	This method is introduce for delaying the loading of streams for a particular job. (Inherited from Job)
DoUnloadJobStreams()	Unloads job streams information. Enables jobs to clear stream information from memory. (Inherited from Job)
LoadJobStreams()	Load the required job streams. (Inherited from Job)
SetJobState(JobState)	Sets Job State. (Inherited from Job)
StopJob()	Stop Job.
UnloadJobStreams()	Unload the required job streams. (Inherited from Job)

Events

StateChanged

Event raised when state of the job changes. (Inherited from Job)