Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

JobSchedule Class

The JobSchedule class represents a SQL Server Agent job schedule.

Namespace:  Microsoft.SqlServer.Management.Smo.Agent
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
[SfcElementTypeAttribute("Schedule")]
public sealed class JobSchedule : ScheduleBase, 
	IAlterable, ICreatable, IDroppable, IRenamable, IScriptable

The JobSchedule type exposes the following members.

  NameDescription
Public methodJobSchedule()Initializes a new instance of the JobSchedule class.
Public methodJobSchedule(SqlSmoObject, String)Initializes a new instance of the JobSchedule class for the specified parent object and that has the specified name.
Top
  NameDescription
Public propertyActiveEndDateGets or sets the date and time when the schedule ends.
Public propertyActiveEndTimeOfDayGets or sets the time when the job schedule stops for the day.
Public propertyActiveStartDateGets or sets the date and time when the schedule starts.
Public propertyActiveStartTimeOfDayGets or sets the time when the job schedule starts for the day.
Public propertyDateCreatedGets the date and time when the job schedule was created.
Public propertyFrequencyIntervalGets or sets the frequency interval, which determines how often the job is scheduled to run.
Public propertyFrequencyRecurrenceFactorGets or sets the number of weeks or months between scheduled jobs for schedules with a weekly or monthly frequency type, respectively.
Public propertyFrequencyRelativeIntervalsGets or sets the ordinal value of a day relative to the first day of the month, such as first, second, or last.
Public propertyFrequencySubDayIntervalGets or sets the interval between scheduled jobs that run during the day.
Public propertyFrequencySubDayTypesGets or sets the unit of time used to specify the interval between scheduled jobs that run during the day.
Public propertyFrequencyTypesGets 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 propertyIDGets the ID value that uniquely identifies the schedule. (Inherited from ScheduleBase.)
Public propertyIsEnabledGets or sets the Boolean property value that specifies whether the job schedule is enabled or disabled.
Public propertyJobCountGets the number of jobs that require the referenced job schedule.
Public propertyNameGets or sets the name of the object. (Inherited from NamedSmoObject.)
Public propertyParentGets or sets the Job object that is the parent of the JobSchedule object.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertyScheduleUidGets or sets a Guid which represents the unique identifier of the schedule.
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyUrnGets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Top
  NameDescription
Public methodAlterUpdates any JobSchedule object property changes on an instance of Microsoft SQL Server. 
Public methodCreateCreates a job schedule on the instance of SQL Server as defined by the JobSchedule object.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDrop()Removes the referenced job schedule.
Public methodDrop(Boolean)Removes the referenced job schedule.
Public methodEnumJobReferencesReturns an enumerated list of jobs that reference the schedule.
Public methodEquals (Inherited from Object.)
Protected methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGetContextDBGets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected methodGetDBNameGets the database name that is associated with the object. (Inherited from AgentObjectBase.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetPropValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalAllowNullGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGetType (Inherited from Object.)
Public methodInitialize()Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public methodInitialize(Boolean)Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected methodIsObjectInitializedVerifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected methodIsObjectInSpaceVerifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public methodRefreshRefreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public methodRenameRenames the job schedule.
Public methodScript()Generates a Transact-SQL script that can be used to re-create the SQL Server Agent job schedule.
Public methodScript(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 methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top
  NameDescription
Public eventPropertyChangedRepresents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public eventPropertyMetadataChangedRepresents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)
Top
  NameDescription
Explicit interface implemetationPrivate methodIAlienObject.DiscoverDiscovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetDomainRootReturns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetParentGets 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 methodIAlienObject.GetPropertyTypeGets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetPropertyValueGets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetUrnGets 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 methodIAlienObject.ResolveGets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetObjectStateSets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetPropertyValueSets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodISfcPropertyProvider.GetPropertySetGets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Top

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.