ScheduledJobSourceAdapter Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Provides functionality for retrieving results of scheduled job runs from the scheduled job store. This class cannot be inherited. Introduced in Windows PowerShell 3.0.

Namespace:   Microsoft.PowerShell.ScheduledJob
Assembly:  Microsoft.PowerShell.ScheduledJob (in Microsoft.PowerShell.ScheduledJob.dll)

System.Object
  System.Management.Automation.JobSourceAdapter
    Microsoft.PowerShell.ScheduledJob.ScheduledJobSourceAdapter

public sealed class ScheduledJobSourceAdapter : JobSourceAdapter

NameDescription
System_CAPS_pubmethodScheduledJobSourceAdapter()

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

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_pubmethodGetJobByInstanceId(Guid, Boolean)

Retrieves a job that contains the specified global identifier. Introduced in Windows PowerShell 3.0.(Overrides JobSourceAdapter.GetJobByInstanceId(Guid, Boolean).)

System_CAPS_pubmethodGetJobBySessionId(Int32, Boolean)

Retrieves a job that contains the specified session identifier. Introduced in Windows PowerShell 3.0.(Overrides JobSourceAdapter.GetJobBySessionId(Int32, Boolean).)

System_CAPS_pubmethodGetJobs()

Retrieves a list of jobs that are currently available in this store. Introduced in Windows PowerShell 3.0.(Overrides JobSourceAdapter.GetJobs().)

System_CAPS_pubmethodGetJobsByCommand(String, Boolean)

Retrieves a 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)

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

System_CAPS_pubmethodGetJobsByName(String, Boolean)

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

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

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 instance of the Job2 results class based on the specified job. Introduced in Windows PowerShell 3.0.(Overrides JobSourceAdapter.NewJob(JobInvocationInfo).)

System_CAPS_pubmethodNewJob(String, String)

Creates a new instance of the Job2 results class based on a definition name that can be run manually. Introduced in Windows PowerShell 3.0.(Overrides JobSourceAdapter.NewJob(String, String).)

System_CAPS_pubmethodPersistJob(Job2)

Saves the scheduled job to the scheduled job store. Introduced in Windows PowerShell 3.0.(Overrides JobSourceAdapter.PersistJob(Job2).)

System_CAPS_pubmethodRemoveJob(Job2)

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

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticAfterFilter

Specifies in the GetJobsByFilter method to search for executed job runs after a particular date. This field is constant. Introduced in Windows PowerShell 3.0.

System_CAPS_pubfieldSystem_CAPS_staticBeforeFilter

Specifies in the GetJobsByFilter method to search for executed job runs before a particular date. This field is constant. Introduced in Windows PowerShell 3.0.

System_CAPS_pubfieldSystem_CAPS_staticNewestFilter

Specifies in the GetJobsByFilter method to search for the newest executed job runs. This field is constant. Introduced in Windows PowerShell 3.0.

An instance of this object is registered with the PowerShell job manager 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.

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

Community Additions

ADD
Show: