Share via

JobSchedule Class

  • Article

The JobSchedule class represents a SQL Server Agent job schedule.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.Agent.AgentObjectBase
          Microsoft.SqlServer.Management.Smo.Agent.ScheduleBase
            Microsoft.SqlServer.Management.Smo.Agent.JobSchedule

Namespace:  Microsoft.SqlServer.Management.Smo.Agent
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
<SfcElementTypeAttribute("Schedule")> _
Public NotInheritable Class JobSchedule _
    Inherits ScheduleBase _
    Implements IAlterable, ICreatable, IDroppable, IRenamable,  _
    IScriptable
'Usage
Dim instance As JobSchedule

[SfcElementTypeAttribute("Schedule")]
public sealed class JobSchedule : ScheduleBase, 
    IAlterable, ICreatable, IDroppable, IRenamable, IScriptable

[SfcElementTypeAttribute(L"Schedule")]
public ref class JobSchedule sealed : public ScheduleBase, 
    IAlterable, ICreatable, IDroppable, IRenamable, IScriptable

[<SealedAttribute>]
[<SfcElementTypeAttribute("Schedule")>]
type JobSchedule =  
    class 
        inherit ScheduleBase 
        interface IAlterable 
        interface ICreatable 
        interface IDroppable 
        interface IRenamable 
        interface IScriptable 
    end

public final class JobSchedule extends ScheduleBase implements IAlterable, ICreatable, IDroppable, IRenamable, IScriptable

The JobSchedule type exposes the following members.

Constructors

  Name Description
Public method JobSchedule() Initializes a new instance of the JobSchedule class.
Public method JobSchedule(SqlSmoObject, String) Initializes a new instance of the JobSchedule class for the specified parent object and that has the specified name.

Top

Properties

  Name Description
Public property ActiveEndDate Gets or sets the date and time when the schedule ends.
Public property ActiveEndTimeOfDay Gets or sets the time when the job schedule stops for the day.
Public property ActiveStartDate Gets or sets the date and time when the schedule starts.
Public property ActiveStartTimeOfDay Gets or sets the time when the job schedule starts for the day.
Public property DateCreated Gets the date and time when the job schedule was created.
Public property FrequencyInterval Gets or sets the frequency interval, which determines how often the job is scheduled to run.
Public property FrequencyRecurrenceFactor Gets or sets the number of weeks or months between scheduled jobs for schedules with a weekly or monthly frequency type, respectively.
Public property FrequencyRelativeIntervals Gets or sets the ordinal value of a day relative to the first day of the month, such as first, second, or last.
Public property FrequencySubDayInterval Gets or sets the interval between scheduled jobs that run during the day.
Public property FrequencySubDayTypes Gets or sets the unit of time used to specify the interval between scheduled jobs that run during the day.
Public property FrequencyTypes Gets or sets the way in which frequency is evaluated for the job schedule, whether it's one time only, or weekly, or when the processor is idle, for example.
Public property ID Gets the ID value that uniquely identifies the schedule. (Inherited from ScheduleBase.)
Public property IsEnabled Gets or sets the Boolean property value that specifies whether the job schedule is enabled or disabled.
Public property JobCount Gets the number of jobs that require the referenced job schedule.
Public property Name Gets or sets the name of the object. (Inherited from NamedSmoObject.)
Public property Parent Gets or sets the Job object that is the parent of the JobSchedule object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property ScheduleUid Gets or sets a Guid which represents the unique identifier of the schedule.
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

  Name Description
Public method Alter Updates any JobSchedule object property changes on an instance of Microsoft SQL Server. 
Public method Create Creates a job schedule on the instance of SQL Server as defined by the JobSchedule object.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop() Removes the referenced job schedule.
Public method Drop(Boolean) Removes the referenced job schedule.
Public method EnumJobReferences Returns an enumerated list of jobs that reference the schedule.
Public method Equals (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GetContextDB Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected method GetDBName Gets the database name that is associated with the object. (Inherited from AgentObjectBase.)
Public method GetHashCode (Inherited from Object.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected method IsObjectInitialized Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public method Refresh Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public method Rename Renames the job schedule.
Public method Script() Generates a Transact-SQL script that can be used to re-create the SQL Server Agent job schedule.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the SQL Server Agent job schedule as specified by the scripting options.
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

  Name Description
Public event PropertyChanged Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public event PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetParent Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)

Top

Remarks

SQL Server Agent jobs can be scheduled to run by using SQL Server Agent. Jobs can be scheduled to run when SQL Server Agent is enabled, but jobs are not required to be scheduled. They can be run on demand by a sufficiently privileged user. Jobs can have more than one active schedule. SQL Server Agent evaluates all schedules to determine when to run the job. By using the JobSchedule object, you can do the following:

  • Create a schedule for a SQL Server Agent job.

  • Remove a schedule from an existing SQL Server Agent job.

  • Manage job schedules either by enabling a schedule or adjusting run times or frequencies.

To get or set JobSchedule object properties, users must be a member of the SQLAgentUserRole database role on the MSDB database, or be the owner of the job, or be a member of the sysadmin fixed server role.

To create a job schedule, users must be a member of the SQLAgentUserRole database role on the MSDB database, or be a member of the sysadmin fixed server role.

To drop a job schedule, users must be a member of the SQLAgentUserRole database role on the MSDB database, or be a member of the sysadmin fixed server role.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Examples

Scheduling Automatic Administrative Tasks in SQL Server Agent

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Management.Smo.Agent Namespace

Other Resources

Automated Administration Tasks (SQL Server Agent)

sp_add_schedule (Transact-SQL)