TechNet
Export (0) Print
Expand All

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, IDropIfExists, IRenamable, IScriptable

NameDescription
System_CAPS_pubmethodJobSchedule()

Initializes a new instance of the JobSchedule class.

System_CAPS_pubmethodJobSchedule(SqlSmoObject, String)

Initializes a new instance of the JobSchedule class for the specified parent object and that has the specified name.

NameDescription
System_CAPS_pubpropertyActiveEndDate

Gets or sets the date and time when the schedule ends.

System_CAPS_pubpropertyActiveEndTimeOfDay

Gets or sets the time when the job schedule stops for the day.

System_CAPS_pubpropertyActiveStartDate

Gets or sets the date and time when the schedule starts.

System_CAPS_pubpropertyActiveStartTimeOfDay

Gets or sets the time when the job schedule starts for the day.

System_CAPS_pubpropertyDateCreated

Gets the date and time when the job schedule was created.

System_CAPS_pubpropertyExecutionManager

(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyFrequencyInterval

Gets or sets the frequency interval, which determines how often the job is scheduled to run.

System_CAPS_pubpropertyFrequencyRecurrenceFactor

Gets or sets the number of weeks or months between scheduled jobs for schedules with a weekly or monthly frequency type, respectively.

System_CAPS_pubpropertyFrequencyRelativeIntervals

Gets or sets the ordinal value of a day relative to the first day of the month, such as first, second, or last.

System_CAPS_pubpropertyFrequencySubDayInterval

Gets or sets the interval between scheduled jobs that run during the day.

System_CAPS_pubpropertyFrequencySubDayTypes

Gets or sets the unit of time used to specify the interval between scheduled jobs that run during the day.

System_CAPS_pubpropertyFrequencyTypes

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.

System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies the schedule.(Inherited from ScheduleBase.)

System_CAPS_pubpropertyIsEnabled

Gets or sets the Boolean property value that specifies whether the job schedule is enabled or disabled.

System_CAPS_pubpropertyJobCount

Gets the number of jobs that require the referenced job schedule.

System_CAPS_pubpropertyName

Gets or sets the name of the object.(Inherited from NamedSmoObject.)

System_CAPS_pubpropertyParent

Gets or sets the Job object that is the parent of the JobSchedule object.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyScheduleUid

Gets or sets a Guid which represents the unique identifier of the schedule.

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubmethodAlter()

Updates any JobSchedule object property changes on an instance of Microsoft SQL Server. 

System_CAPS_pubmethodCreate()

Creates a job schedule on the instance of SQL Server as defined by the JobSchedule object.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDrop()

Removes the referenced job schedule.

System_CAPS_pubmethodDrop(Boolean)

Removes the referenced job schedule.

System_CAPS_pubmethodDropIfExists()

System_CAPS_pubmethodEnumJobReferences()

Returns an enumerated list of jobs that reference the schedule.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from AgentObjectBase.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodIsSupportedProperty(String)

(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRefresh()

Refreshes the object and retrieves properties when the object is next accessed.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRename(String)

Renames the job schedule.

System_CAPS_pubmethodScript()

Generates a Transact-SQL script that can be used to re-create the SQL Server Agent job schedule.

System_CAPS_pubmethodScript(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.

System_CAPS_protmethodSetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodValidate(String, Object[])

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyType(String)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider.GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

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.

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.

Return to top
Show:
© 2016 Microsoft