JobSourceAdapter Class

Reference

Definition

Namespace:: System.Management.Automation

Assembly:: System.Management.Automation.dll

Package:: Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0

Package:: System.Management.Automation v7.0.13

Package:: System.Management.Automation v7.1.7

Package:: System.Management.Automation v7.2.12

Package:: System.Management.Automation v7.3.5

Package:: System.Management.Automation v7.4.0

Package:: Microsoft.WSMan.Runtime v6.1.0

Package:: Microsoft.WSMan.Runtime v6.2.0

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.

Abstract class for a job store which will contain the jobs of a specific type.

public ref class JobSourceAdapter abstract

public abstract class JobSourceAdapter

type JobSourceAdapter = class

Public MustInherit Class JobSourceAdapter

Inheritance: Object
JobSourceAdapter

Derived: Microsoft.PowerShell.Workflow.WorkflowJobSourceAdapter

Constructors

JobSourceAdapter()

Properties

Name	Name for this store.

Methods

GetJobByInstanceId(Guid, Boolean)	Get list of jobs that has the specified id.
GetJobBySessionId(Int32, Boolean)	Get job that has specific session id.
GetJobs()	Get the list of jobs that are currently available in this store.
GetJobsByCommand(String, Boolean)	Get list of jobs that run the specified command.
GetJobsByFilter(Dictionary<String,Object>, Boolean)	Get list of jobs based on the adapter specific filter parameters.
GetJobsByName(String, Boolean)	Get list of jobs that matches the specified names.
GetJobsByState(JobState, Boolean)	Get list of jobs that are in the specified state.
NewJob(JobDefinition)	Create a new job with the specified definition.
NewJob(JobInvocationInfo)	Create a new job with the specified JobSpecification.
NewJob(String, String)	Creates a new job with the definition as specified by the provided definition name and path. If path is null then a default location will be used to find the job definition by name.
PersistJob(Job2)	Saves the job to a persisted store.
RemoveJob(Job2)	Remove a job from the store.
RetrieveJobIdForReuse(Guid)	Get a token that allows for construction of a job with a previously assigned Id and InstanceId. This is only possible if this JobSourceAdapter is the creator of the original job. The original job must have been saved using "SaveJobIdForReconstruction"
StoreJobIdForReuse(Job2, Boolean)	Saves the Id information for a job so that it can be constructed at a later time. This will only allow this job source adapter type to recreate the job.

Applies to