ScheduledJob Members

Article
03/24/2015

Represents a scheduled job. This class cannot be inherited. Introduced in Windows PowerShell 3.0.

The following tables list the members exposed by the ScheduledJob type.

Public Constructors

	Name	Description
	ScheduledJob	Initializes a new instance of the ScheduledJob class. Introduced in Windows PowerShell 3.0.

Top

Public Properties

(see also Protected Properties)

	Name	Description
	ChildJobs	Gets a list of the child jobs included in this job. This property is introduced in Windows PowerShell 2.0. (Inherited from Job)
	Command	Gets the command string for the scheduled job. Introduced in Windows PowerShell 3.0.
	Debug	Gets and sets the buffer where debug information is stored. This property is introduced in Windows PowerShell 2.0. (Inherited from Job)
	Definition	Gets the definition of the scheduled job. Introduced in Windows PowerShell 3.0.
	Error	Gets and sets the buffer where error information is stored. This property is introduced in Windows PowerShell 2.0. (Inherited from Job)
	Finished	Gets the wait handle that is signaled when job is finished. This property is introduced in Windows PowerShell 2.0. (Inherited from Job)
	HasMoreData	Overridden. Indicates whether more data is available from the scheduled job. Introduced in Windows PowerShell 3.0.
	Id	Gets the identifier of the job. This property is introduced in Windows PowerShell 2.0. (Inherited from Job)
	InstanceId	Gets the identifier of this instance of the job. The instance identifier of the job is unique throughout all runspaces. This property is introduced in Windows PowerShell 2.0. (Inherited from Job)
	JobStateInfo	Gets the status of the job. This property is introduced in Windows PowerShell 2.0. (Inherited from Job)
	Location	Overridden. Gets the location of the scheduled job. Introduced in Windows PowerShell 3.0.
	Name	Gets and sets the name that can be used to identify the job. This property is introduced in Windows PowerShell 2.0. (Inherited from Job)
	Output	Gets and sets the output buffer for the job. This property is introduced in Windows PowerShell 2.0. (Inherited from Job)
	Progress	Gets and sets the progress buffer for the job. This property is introduced in Windows PowerShell 2.0. (Inherited from Job)
	PSBeginTime	Gets or sets when to begin the job. Introduced in Windows PowerShell 3.0. (Inherited from Job)
	PSEndTime	Gets or sets when to end the job. Introduced in Windows PowerShell 3.0. (Inherited from Job)
	PSJobTypeName	Gets or sets the job type name. Introduced in Windows PowerShell 3.0. (Inherited from Job)
	StartParameters	Gets or sets the parameters that are used to start a job. Introduced in Windows PowerShell 3.0. (Inherited from Job2)
	StatusMessage	Overridden. Gets the status message associated with the scheduled job. Introduced in Windows PowerShell 3.0.
	Verbose	Gets and sets the verbose buffer for the job. This property is introduced in Windows PowerShell 2.0. (Inherited from Job)
	Warning	Gets and sets the warning buffer for the job. This property is introduced in Windows PowerShell 2.0. (Inherited from Job)

Top

Protected Properties

	Name	Description
	SyncRoot	TBD Introduced in Windows PowerShell 3.0. (Inherited from Job2)

Top

Public Methods

(see also Protected Methods)

	Name	Description
	Dispose	Overloaded. Releases the resources that are used by the Job object. These methods implement the Dispose pattern used to release managed and unmanaged resources. This method is introduced in Windows PowerShell 2.0. (Inherited from Job)
	Equals	(Inherited from Object)
	GetHashCode	(Inherited from Object)
	GetObjectData	Populates an object with the data needed to serialize the scheduled job. Introduced in Windows PowerShell 3.0.
	GetType	(Inherited from Object)
	LoadJobStreams	Loads the required job streams. Introduced in Windows PowerShell 3.0. (Inherited from Job)
	ResumeJob	Overridden. Not supported. Introduced in Windows PowerShell 3.0.
	ResumeJobAsync	Overridden. Not supported. Introduced in Windows PowerShell 3.0.
	StartJob	Overridden. Starts a scheduled job as defined by the contained ScheduledJobDefinition object. Introduced in Windows PowerShell 3.0.
	StartJobAsync	Overridden. Not supported. Introduced in Windows PowerShell 3.0.
	StopJob	Overloaded. Overridden. Stops the scheduled job from running. Introduced in Windows PowerShell 3.0.
	StopJobAsync	Overloaded. Overridden. Asynchronously stops the scheduled job from running. Introduced in Windows PowerShell 3.0.
	SuspendJob	Overloaded. Overridden. Not supported. Introduced in Windows PowerShell 3.0.
	SuspendJobAsync	Overloaded. Overridden. Not supported. Introduced in Windows PowerShell 3.0.
	ToString	(Inherited from Object)
	UnblockJob	Overridden. Not supported. Introduced in Windows PowerShell 3.0.
	UnblockJobAsync	Overridden. Not supported. Introduced in Windows PowerShell 3.0.
	UnloadJobStreams	Unloads the required job streams. Introduced in Windows PowerShell 3.0. (Inherited from Job)

Top

Protected Methods

(see also Extension Methods)

	Name	Description
	AutoGenerateJobName	Automatically adds the specified job name if the user does not supply one when creating the job. This method is introduced in Windows PowerShell 2.0. (Inherited from Job)
	Dispose	Overloaded. Releases the resources that are used by the Job object. These methods implement the Dispose pattern used to release managed and unmanaged resources. This method is introduced in Windows PowerShell 2.0. (Inherited from Job)
	DoLoadJobStreams	Specifies the loading of the streams for a particular job. Introduced in Windows PowerShell 3.0. (Inherited from Job)
	DoUnloadJobStreams	Unloads job stream information, which enables jobs to clear stream information from memory. Introduced in Windows PowerShell 3.0. (Inherited from Job)
	Finalize	(Inherited from Object)
	MemberwiseClone	(Inherited from Object)
	OnResumeJobCompleted	Raises the event when resuming a suspended job is completed. Introduced in Windows PowerShell 3.0. (Inherited from Job2)
	OnStartJobCompleted	Raises the event when the starting of a job is completed. Introduced in Windows PowerShell 3.0. (Inherited from Job2)
	OnStopJobCompleted	Raises the event when the stopping of a job is completed. Introduced in Windows PowerShell 3.0. (Inherited from Job2)
	OnSuspendJobCompleted	Raises the event when the suspending of a job is completed. Introduced in Windows PowerShell 3.0. (Inherited from Job2)
	OnUnblockJobCompleted	Raises the event when the unblocking of a blocked job is completed. Introduced in Windows PowerShell 3.0. (Inherited from Job2)
	SetJobState	Sets the status of the job, such as is it running, has it completed, or has it failed. This method is introduced in Windows PowerShell 2.0. (Inherited from Job)
	SetJobState	Stores the state of the job. Introduced in Windows PowerShell 3.0. (Inherited from Job2)

Top

Extension Methods

	Name	Description
	As	Use this method to adapt an object from a foreign app domain to a known interface in this app domain.This element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
	As	This is called to adapt an object from a foreign app domain to a known interface in this appDomainThis element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
	As	Adapts an object from a foreign app domain to a known interface in this app domain.This element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
	Extend	Use this method to adapt and extend an object so that you can pass it to a foreign app domain.This element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
	Extend	This is called to adapt and extend an object that we wish to pass to a foreign app domainThis element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
	Extend	Used to extend an object with an interface from a foreign app domain.This element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
	ToEnumerable	This element is introduced in Windows PowerShell 5.0. (Defined by CollectionExtensions.)

Top

Public Events

	Name	Description
	ResumeJobCompleted	Occurs when the asynchronous resuming of a suspended job is completed. Introduced in Windows PowerShell 3.0. (Inherited from Job2)
	StartJobCompleted	Occurs when the start job activity is completed. Introduced in Windows PowerShell 3.0. (Inherited from Job2)
	StateChanged	Event fired when the status of the job changes, such as when the job has completed in all runspaces or failed in any one runspace. This event is introduced in Windows PowerShell 2.0. (Inherited from Job)
	StopJobCompleted	Occurs when the asynchronous stopping of a job is completed. Introduced in Windows PowerShell 3.0. (Inherited from Job2)
	SuspendJobCompleted	Occurs when the asynchronous suspending of a job is completed. Introduced in Windows PowerShell 3.0. (Inherited from Job2)
	UnblockJobCompleted	Occurs when the asynchronous unblocking of a blocked job is completed. Introduced in Windows PowerShell 3.0. (Inherited from Job2)

Top