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.

WorkflowJobSourceAdapter Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Allows workflow instances to be exposed as jobs in Windows PowerShell. Instances of this class manage the collection of jobs associated with a Windows PowerShell workflow. Introduced in Windows PowerShell 3.0.

Namespace:   Microsoft.PowerShell.Workflow
Assembly:  Microsoft.PowerShell.Workflow.ServiceCore (in Microsoft.PowerShell.Workflow.ServiceCore.dll)

System.Object
  System.Management.Automation.JobSourceAdapter
    Microsoft.PowerShell.Workflow.WorkflowJobSourceAdapter

public sealed class WorkflowJobSourceAdapter : JobSourceAdapter

NameDescription
System_CAPS_pubpropertyName

Gets or sets the name of the job store. Introduced in Windows PowerShell 3.0.(Inherited from JobSourceAdapter.)

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticGetInstance()

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

System_CAPS_pubmethodGetJobByInstanceId(Guid, Boolean)

Gets the job with the specified GUID, and optionally gets child jobs with the same GUID. Introduced in Windows PowerShell 3.0.(Overrides JobSourceAdapter.GetJobByInstanceId(Guid, Boolean).)

System_CAPS_pubmethodGetJobBySessionId(Int32, Boolean)

Gets the job with the specified session ID. Introduced in Windows PowerShell 3.0.(Overrides JobSourceAdapter.GetJobBySessionId(Int32, Boolean).)

System_CAPS_pubmethodGetJobManager()

Gets the current PSWorkflowJobManager object. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodGetJobs()

Gets the list of jobs that are currently available in the workflow instance table. Introduced in Windows PowerShell 3.0.(Overrides JobSourceAdapter.GetJobs().)

System_CAPS_pubmethodGetJobsByCommand(String, Boolean)

Gets the list of jobs that run the specified command. Introduced in Windows PowerShell 3.0.(Overrides JobSourceAdapter.GetJobsByCommand(String, Boolean).)

System_CAPS_pubmethodGetJobsByFilter(Dictionary<String, Object>, Boolean)

Gets the list of jobs based on the adapter-specific filter parameters. Introduced in Windows PowerShell 3.0.(Overrides JobSourceAdapter.GetJobsByFilter(Dictionary<String, Object>, Boolean).)

System_CAPS_pubmethodGetJobsByName(String, Boolean)

Gets a list of jobs that matches the specified names. Introduced in Windows PowerShell 3.0.(Overrides JobSourceAdapter.GetJobsByName(String, Boolean).)

System_CAPS_pubmethodGetJobsByState(JobState, Boolean)

Gets the list of jobs that are in the specified state. Introduced in Windows PowerShell 3.0.(Overrides JobSourceAdapter.GetJobsByState(JobState, Boolean).)

System_CAPS_pubmethodGetPSWorkflowRuntime()

Gets the Powershell workflow runtime information. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodNewJob(JobDefinition)

Creates a new job with the specified job definition. Introduced in Windows PowerShell 3.0.(Inherited from JobSourceAdapter.)

System_CAPS_pubmethodNewJob(JobInvocationInfo)

Creates a new job with the specified job invocation information. Introduced in Windows PowerShell 3.0.(Overrides JobSourceAdapter.NewJob(JobInvocationInfo).)

System_CAPS_pubmethodNewJob(String, String)

Creates a new job with the job definition as specified by the provided name and path. Introduced in Windows PowerShell 3.0.(Inherited from JobSourceAdapter.)

System_CAPS_pubmethodPersistJob(Job2)

Saves the job to a persisted store. Introduced in Windows PowerShell 3.0.(Inherited from JobSourceAdapter.)

System_CAPS_pubmethodRemoveJob(Job2)

Removes the specified job from the store. Introduced in Windows PowerShell 3.0.(Overrides JobSourceAdapter.RemoveJob(Job2).)

System_CAPS_pubmethodStoreJobIdForReuse(Job2, Boolean)

Stores the identifier information for a job so that it can be reconstructed at a later time. Introduced in Windows PowerShell 3.0.(Inherited from JobSourceAdapter.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

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: