Share via


ScheduledJobSourceAdapter Class

Definition

This class provides functionality for retrieving scheduled job run results from the scheduled job store. An instance of this object will be registered with the PowerShell JobManager so that GetJobs commands will retrieve schedule job runs from the file based scheduled job store. This allows scheduled job runs to be managed from PowerShell in the same way workflow jobs are managed.

public sealed class ScheduledJobSourceAdapter : System.Management.Automation.JobSourceAdapter
type ScheduledJobSourceAdapter = class
    inherit JobSourceAdapter
Public NotInheritable Class ScheduledJobSourceAdapter
Inherits JobSourceAdapter
Inheritance
ScheduledJobSourceAdapter

Constructors

ScheduledJobSourceAdapter()

Constructor.

Fields

AfterFilter

AfterFilter

BeforeFilter

BeforeFilter

NewestFilter

NewestFilter

Properties

Name

Name for this store.

(Inherited from JobSourceAdapter)

Methods

GetJobByInstanceId(Guid, Boolean)

Get job 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.

(Inherited from JobSourceAdapter)
NewJob(JobInvocationInfo)

Create a new Job2 results instance.

NewJob(String, String)

Creates a new Job2 object based on a definition name that can be run manually. If the path parameter is null then a default location will be used to find the job definition by name.

PersistJob(Job2)

Saves job to scheduled job run 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"

(Inherited from JobSourceAdapter)
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.

(Inherited from JobSourceAdapter)

Applies to