PSWorkflowJob Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Workflow Job type implementation. For use with the WorkflowJobSourceAdapter.
public ref class PSWorkflowJob : System::Management::Automation::Job2, System::Management::Automation::IJobDebuggerpublic class PSWorkflowJob : System.Management.Automation.Job2, System.Management.Automation.IJobDebuggertype PSWorkflowJob = class
inherit Job2
interface IJobDebuggerPublic Class PSWorkflowJob
Inherits Job2
Implements IJobDebugger- Inheritance
- Implements
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) |
| Debugger |
Job Debugger |
| 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 that more data is available in this result object for reading. |
| 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) |
| IsAsync |
True if job is synchronous and can be debugged. |
| JobStateInfo |
Status of the command execution. (Inherited from Job) |
| Location |
Indicates a location where this job is running. |
| Name |
Name for identifying this job object. (Inherited from Job) |
| OnIdle |
Delegate action on workflow idling |
| OnPersistableIdleAction |
Delegate function on workflow persist idle action |
| OnUnloaded |
Delegate action on workflow unloaded |
| 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) |
| PSWorkflowDebugger |
Workflow debugger |
| PSWorkflowInstance |
Workflow instance for the job |
| StartParameters |
Parameters to be used to start a job. This is a property because CommandParameterCollection does not have a public constructor. Hence the infrastructure creates an instance and provides it for the implementations to use. (Inherited from Job2) |
| StatusMessage |
Success status of the command execution. |
| SyncRoot | (Inherited from Job2) |
| 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) | |
| DoLoadJobStreams() |
Implementation of this method will allow the delayed loadig of streams. |
| DoResumeBookmark(Bookmark, Object) |
DoResumeBookmark |
| DoUnloadJobStreams() |
Unloads job streams information. Enables jobs to clear stream information from memory |
| GetPersistableIdleAction(ReadOnlyCollection<BookmarkInfo>, Boolean) |
GetPersistableIdleAction |
| LoadJobStreams() |
Load the required job streams. (Inherited from Job) |
| OnResumeJobCompleted(AsyncCompletedEventArgs) |
Method which can be extended or called by derived classes to raise the event when resuming a suspended job is completed. (Inherited from Job2) |
| OnStartJobCompleted(AsyncCompletedEventArgs) |
Method which can be extended or called by derived classes to raise the event when start of the job is completed. (Inherited from Job2) |
| OnStopJobCompleted(AsyncCompletedEventArgs) |
Method which can be extended or called by derived classes to raise the event when stopping a job is completed. (Inherited from Job2) |
| OnSuspendJobCompleted(AsyncCompletedEventArgs) |
Method which can be extended or called by derived classes to raise the event when suspending a job is completed. (Inherited from Job2) |
| OnUnblockJobCompleted(AsyncCompletedEventArgs) |
Method which can be extended or called by derived classes to raise the event when unblocking a blocked job is completed. (Inherited from Job2) |
| ResumeBookmark(Bookmark, Boolean, PowerShellStreams<PSObject,PSObject>, Exception) |
ResumeBookmark |
| ResumeBookmark(Bookmark, Boolean, PowerShellStreams<PSObject,PSObject>) |
ResumeBookmark |
| ResumeBookmark(Bookmark, Object) |
ResumeBookmark |
| ResumeJob() |
Resume a suspended job |
| ResumeJob(String) |
Resume a suspended job |
| ResumeJobAsync() |
Resume a suspended job asynchronously. |
| ResumeJobAsync(String) |
Resume a suspended job asynchronously. |
| SetJobState(JobState, Exception) |
There is an internal method in Job which is not made public. In order to make this available to someone implementing a job it has to be added here. If the original method is made public it has changes of colliding with some implementation which may have added that method. (Inherited from Job2) |
| SetJobState(JobState) |
Sets Job State. (Inherited from Job) |
| StartJob() |
start a job. The job will be started with the parameters specified in StartParameters |
| StartJobAsync() |
Start a job asynchronously |
| StopJob() | |
| StopJob(Boolean, String, Boolean) |
Stop Job |
| StopJob(Boolean, String) |
Stop Job |
| StopJobAsync() |
Stop a job asynchronously |
| StopJobAsync(Boolean, String, Boolean) |
Stop job asynchronously |
| StopJobAsync(Boolean, String) |
Stop Job Asynchronously |
| SuspendJob() |
Suspend a job |
| SuspendJob(Boolean, String) |
Suspend Job |
| SuspendJobAsync() |
Asynchronously suspend a job |
| SuspendJobAsync(Boolean, String) |
Suspend Job Asynchronously |
| UnblockJob() |
Unblock a blocked job |
| UnblockJobAsync() |
Unblock a blocked job asynchronously |
| UnloadJobStreams() |
Unload the required job streams. (Inherited from Job) |
Events
| ResumeJobCompleted |
This event should be raised whenever the asynchronous resume of a suspended job is completed. This event should not be raised for synchronous operation. (Inherited from Job2) |
| StartJobCompleted |
Event to be raise when the start job activity is completed. This event should not be raised for synchronous operation. (Inherited from Job2) |
| StateChanged |
Event raised when state of the job changes. (Inherited from Job) |
| StopJobCompleted |
Event to be raised when the asynchronous stopping of a job is completed.This event should not be raised for synchronous operation. (Inherited from Job2) |
| SuspendJobCompleted |
This event should be raised whenever the asynchronous suspend of a job is completed. This event should not be raised for synchronous operation. (Inherited from Job2) |
| UnblockJobCompleted |
This event should be raised whenever the asynchronous unblock of a blocked job is completed. This event should not be raised for synchronous operation. (Inherited from Job2) |