Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ScheduledJob Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

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

Namespace:   Microsoft.PowerShell.ScheduledJob
Assembly:  Microsoft.PowerShell.ScheduledJob (in Microsoft.PowerShell.ScheduledJob.dll)

System.Object
  System.Management.Automation.Job
    System.Management.Automation.Job2
      Microsoft.PowerShell.ScheduledJob.ScheduledJob

<SerializableAttribute>
Public NotInheritable Class ScheduledJob
	Inherits Job2
	Implements ISerializable

NameDescription
System_CAPS_pubmethodScheduledJob(String, String, ScheduledJobDefinition)

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

NameDescription
System_CAPS_pubpropertyChildJobs

Gets a list of the child jobs included in this job. This property is introduced in Windows PowerShell 2.0.(Inherited from Job.)

System_CAPS_pubpropertyCommand

Gets the command string for the scheduled job. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyDebug

Gets and sets the buffer where debug information is stored. This property is introduced in Windows PowerShell 2.0.(Inherited from Job.)

System_CAPS_pubpropertyDefinition

Gets the definition of the scheduled job. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyError

Gets and sets the buffer where error information is stored. This property is introduced in Windows PowerShell 2.0.(Inherited from Job.)

System_CAPS_pubpropertyFinished

Gets the wait handle that is signaled when job is finished. This property is introduced in Windows PowerShell 2.0.(Inherited from Job.)

System_CAPS_pubpropertyHasMoreData

Indicates whether more data is available from the scheduled job. Introduced in Windows PowerShell 3.0.(Overrides Job.HasMoreData.)

System_CAPS_pubpropertyId

Gets the identifier of the job. This property is introduced in Windows PowerShell 2.0.(Inherited from Job.)

System_CAPS_pubpropertyInformation

Gets or sets the information buffer. Information records of job are written to this buffer. (Inherited from Job.)

System_CAPS_pubpropertyInstanceId

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.)

System_CAPS_pubpropertyJobStateInfo

Gets the status of the job. This property is introduced in Windows PowerShell 2.0.(Inherited from Job.)

System_CAPS_pubpropertyLocation

Gets the location of the scheduled job. Introduced in Windows PowerShell 3.0.(Overrides Job.Location.)

System_CAPS_pubpropertyName

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.)

System_CAPS_pubpropertyOutput

Gets and sets the output buffer for the job. This property is introduced in Windows PowerShell 2.0.(Inherited from Job.)

System_CAPS_pubpropertyProgress

Gets and sets the progress buffer for the job. This property is introduced in Windows PowerShell 2.0.(Inherited from Job.)

System_CAPS_pubpropertyPSBeginTime

Gets or sets when to begin the job. Introduced in Windows PowerShell 3.0.(Inherited from Job.)

System_CAPS_pubpropertyPSEndTime

Gets or sets when to end the job. Introduced in Windows PowerShell 3.0.(Inherited from Job.)

System_CAPS_pubpropertyPSJobTypeName

Gets or sets the job type name. Introduced in Windows PowerShell 3.0.(Inherited from Job.)

System_CAPS_pubpropertyStartParameters

Gets or sets the parameters that are used to start a job. Introduced in Windows PowerShell 3.0.(Inherited from Job2.)

System_CAPS_pubpropertyStatusMessage

Gets the status message associated with the scheduled job. Introduced in Windows PowerShell 3.0.(Overrides Job.StatusMessage.)

System_CAPS_pubpropertyVerbose

Gets and sets the verbose buffer for the job. This property is introduced in Windows PowerShell 2.0.(Inherited from Job.)

System_CAPS_pubpropertyWarning

Gets and sets the warning buffer for the job. This property is introduced in Windows PowerShell 2.0.(Inherited from Job.)

NameDescription
System_CAPS_pubmethodDispose()

Releases the resources used by the Job object. This method is introduced in Windows PowerShell 2.0.(Inherited from Job.)

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetObjectData(SerializationInfo, StreamingContext)

Populates an object with the data needed to serialize the scheduled job. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodLoadJobStreams()

Loads the required job streams. Introduced in Windows PowerShell 3.0.(Inherited from Job.)

System_CAPS_pubmethodResumeJob()

Not supported. Introduced in Windows PowerShell 3.0.(Overrides Job2.ResumeJob().)

System_CAPS_pubmethodResumeJobAsync()

Not supported. Introduced in Windows PowerShell 3.0.(Overrides Job2.ResumeJobAsync().)

System_CAPS_pubmethodStartJob()

Starts a scheduled job as defined by the contained ScheduledJobDefinition object. Introduced in Windows PowerShell 3.0.(Overrides Job2.StartJob().)

System_CAPS_pubmethodStartJobAsync()

Not supported. Introduced in Windows PowerShell 3.0.(Overrides Job2.StartJobAsync().)

System_CAPS_pubmethodStopJob()

Stops the scheduled job from running. Introduced in Windows PowerShell 3.0.(Overrides Job.StopJob().)

System_CAPS_pubmethodStopJob(Boolean, String)

Stops the scheduled job from running. Introduced in Windows PowerShell 3.0.(Overrides Job2.StopJob(Boolean, String).)

System_CAPS_pubmethodStopJobAsync()

Asynchronously stops the scheduled job from running. Introduced in Windows PowerShell 3.0.(Overrides Job2.StopJobAsync().)

System_CAPS_pubmethodStopJobAsync(Boolean, String)

Asynchronously stops the scheduled job from running. Introduced in Windows PowerShell 3.0.(Overrides Job2.StopJobAsync(Boolean, String).)

System_CAPS_pubmethodSuspendJob()

Not supported. Introduced in Windows PowerShell 3.0.(Overrides Job2.SuspendJob().)

System_CAPS_pubmethodSuspendJob(Boolean, String)

Not supported. Introduced in Windows PowerShell 3.0.(Overrides Job2.SuspendJob(Boolean, String).)

System_CAPS_pubmethodSuspendJobAsync()

Not supported. Introduced in Windows PowerShell 3.0.(Overrides Job2.SuspendJobAsync().)

System_CAPS_pubmethodSuspendJobAsync(Boolean, String)

Not supported. Introduced in Windows PowerShell 3.0.(Overrides Job2.SuspendJobAsync(Boolean, String).)

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUnblockJob()

Not supported. Introduced in Windows PowerShell 3.0.(Overrides Job2.UnblockJob().)

System_CAPS_pubmethodUnblockJobAsync()

Not supported. Introduced in Windows PowerShell 3.0.(Overrides Job2.UnblockJobAsync().)

System_CAPS_pubmethodUnloadJobStreams()

Unloads the required job streams. Introduced in Windows PowerShell 3.0.(Inherited from Job.)

NameDescription
System_CAPS_pubeventResumeJobCompleted

Occurs when the asynchronous resuming of a suspended job is completed. Introduced in Windows PowerShell 3.0.(Inherited from Job2.)

System_CAPS_pubeventStartJobCompleted

Occurs when the start job activity is completed. Introduced in Windows PowerShell 3.0.(Inherited from Job2.)

System_CAPS_pubeventStateChanged

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.)

System_CAPS_pubeventStopJobCompleted

Occurs when the asynchronous stopping of a job is completed. Introduced in Windows PowerShell 3.0.(Inherited from Job2.)

System_CAPS_pubeventSuspendJobCompleted

Occurs when the asynchronous suspending of a job is completed. Introduced in Windows PowerShell 3.0.(Inherited from Job2.)

System_CAPS_pubeventUnblockJobCompleted

Occurs when the asynchronous unblocking of a blocked job is completed. Introduced in Windows PowerShell 3.0.(Inherited from Job2.)

This class is used to load job result data from previously run jobs so that a user can view results of scheduled job runs. This class also contains the definition of the scheduled job, so it can run an instance of the scheduled job and optionally save the results to a file.

This class can be serialized.

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: