PSJobProxy Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Represents the class that handles the hosting and executing of workflows in Windows PowerShell. This class cannot be inherited. Introduced in Windows PowerShell 3.0.

Namespace:   System.Management.Automation
Assembly:  System.Management.Automation (in System.Management.Automation.dll)

System.Object
  System.Management.Automation.Job
    System.Management.Automation.Job2
      System.Management.Automation.PSJobProxy

public sealed class PSJobProxy : Job2

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 that is run by this job. This property is introduced in Windows PowerShell 2.0.(Inherited from Job.)

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_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

Gets a value that indicates whether more data is available for reading. 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 string from the remote 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_pubpropertyRemoteJobInstanceId

Gets the global identifier for the instance of the remote job that this proxy interacts with. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyRemoveRemoteJobOnCompletion

Gets or sets a value that indicates whether the remote job is removed when it has been completed and the data has been received. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyRunspace

Gets or sets the runspace in which this job is executed. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyRunspacePool

Gets or sets the runspace pool in which this job is executed. Introduced in Windows PowerShell 3.0.

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 from the command execution. 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_pubmethodSystem_CAPS_staticCreate(Runspace)

Creates a collection of job proxies to interact with jobs from a runspace. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodSystem_CAPS_staticCreate(Runspace, Hashtable)

Creates a collection of job proxies to interact with jobs that are filtered from a runspace. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodSystem_CAPS_staticCreate(Runspace, Hashtable, Boolean)

Creates a collection of job proxies to interact with jobs that are filtered from a runspace, with the option to start the data streaming immediately. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodSystem_CAPS_staticCreate(Runspace, Hashtable, EventHandler<JobDataAddedEventArgs>, EventHandler<JobStateEventArgs>)

Creates a collection of job proxies to interact with jobs that are filtered from a runspace, while specifying event handlers to respond when data is added or the state is changed in a child job. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodSystem_CAPS_staticCreate(RunspacePool)

Creates a collection of job proxies to interact with jobs from a runspace pool. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodSystem_CAPS_staticCreate(RunspacePool, Hashtable)

Creates a collection of job proxies to interact with jobs that are filtered from a runspace pool. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodSystem_CAPS_staticCreate(RunspacePool, Hashtable, Boolean)

Creates a collection of job proxies to interact with jobs that are filtered from a runspace pool, with the option to start the data streaming immediately. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodSystem_CAPS_staticCreate(RunspacePool, Hashtable, EventHandler<JobDataAddedEventArgs>, EventHandler<JobStateEventArgs>)

Creates a collection of job proxies to interact with jobs that are filtered from a runspace pool, while specifying event handlers to respond when data is added or the state is changed in a child job. Introduced in Windows PowerShell 3.0.

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_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodLoadJobStreams()

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

System_CAPS_pubmethodReceiveJob()

Begins streaming data for a job object that was created by the Create method and has not been started. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodReceiveJob(EventHandler<JobDataAddedEventArgs>, EventHandler<JobStateEventArgs>)

Begins streaming data for a job object that was created by the Create method and has not been started, while specifying event handlers to respond when data is added or the state is changed in a child job. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodRemoveJob(Boolean)

Removes the remote or local job synchronously. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodRemoveJob(Boolean, Boolean)

Removes the remote or local job synchronously, with the option to stop the job on the server before attempting removal. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodRemoveJobAsync(Boolean)

Removes the remote or local job asynchronously, with the option to stop the job on the server before attempting removal. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodRemoveJobAsync(Boolean, Boolean)

Removes the remote or local job asynchronously. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodResumeJob()

Resumes a suspended job synchronously. Introduced in Windows PowerShell 3.0.(Overrides Job2.ResumeJob().)

System_CAPS_pubmethodResumeJobAsync()

Resumes a suspended job asynchronously. Introduced in Windows PowerShell 3.0.(Overrides Job2.ResumeJobAsync().)

System_CAPS_pubmethodStartJob()

Starts a job synchronously. Introduced in Windows PowerShell 3.0.(Overrides Job2.StartJob().)

System_CAPS_pubmethodStartJob(EventHandler<JobDataAddedEventArgs>, EventHandler<JobStateEventArgs>, PSDataCollection<Object>)

Starts a job synchronously with the specified input to the underlying pipeline and handlers for events that happen to the child jobs. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodStartJob(PSDataCollection<Object>)

Starts a job synchronously with the specified input to the underlying pipeline. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodStartJobAsync()

Starts a job asynchronously. Introduced in Windows PowerShell 3.0.(Overrides Job2.StartJobAsync().)

System_CAPS_pubmethodStartJobAsync(EventHandler<JobDataAddedEventArgs>, EventHandler<JobStateEventArgs>, PSDataCollection<Object>)

Starts a job asynchronously with the specified input to the underlying pipeline and handlers for events that happen to the child jobs. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodStartJobAsync(PSDataCollection<Object>)

Starts a job asynchronously with the specified input to the underlying pipeline. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodStopJob()

Stops a job synchronously. Introduced in Windows PowerShell 3.0.(Overrides Job.StopJob().)

System_CAPS_pubmethodStopJob(Boolean, String)

Stops a job synchronously, with the option to force the stopping of the job. Introduced in Windows PowerShell 3.0.(Overrides Job2.StopJob(Boolean, String).)

System_CAPS_pubmethodStopJobAsync()

Stops a job asynchronously. Introduced in Windows PowerShell 3.0.(Overrides Job2.StopJobAsync().)

System_CAPS_pubmethodStopJobAsync(Boolean, String)

Stops a job asynchronously, with the option to force the stopping of the job. Introduced in Windows PowerShell 3.0.(Overrides Job2.StopJobAsync(Boolean, String).)

System_CAPS_pubmethodSuspendJob()

Suspends a job synchronously. Introduced in Windows PowerShell 3.0.(Overrides Job2.SuspendJob().)

System_CAPS_pubmethodSuspendJob(Boolean, String)

Suspends a job synchronously, with the option to force the suspending of the job. Introduced in Windows PowerShell 3.0.(Overrides Job2.SuspendJob(Boolean, String).)

System_CAPS_pubmethodSuspendJobAsync()

Suspends a job asynchronously. Introduced in Windows PowerShell 3.0.(Overrides Job2.SuspendJobAsync().)

System_CAPS_pubmethodSuspendJobAsync(Boolean, String)

Suspends a job asynchronously, with the option to force the suspending of the job. Introduced in Windows PowerShell 3.0.(Overrides Job2.SuspendJobAsync(Boolean, String).)

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUnblockJob()

Unblocks a blocked job synchronously. Introduced in Windows PowerShell 3.0.(Overrides Job2.UnblockJob().)

System_CAPS_pubmethodUnblockJobAsync()

Unblocks a blocked job asynchronously. 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_pubeventRemoveJobCompleted

Occurs when the asynchronous removal of a server side job is completed. Introduced in Windows PowerShell 3.0.

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

The objects on the client act as proxies to the real objects on the server.

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: