Export (0) Print
Expand All

Job Class

The Job class represents a Microsoft SQL Server Agent job.

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

public sealed class Job : AgentObjectBase, IAlterable, 
	ICreatable, IDroppable, IRenamable, IScriptable

The Job type exposes the following members.

  NameDescription
Public methodJob()Initializes a new instance of the Job class.
Public methodJob(JobServer, String)Initializes a new instance of the Job class on the specified instance of Microsoft SQL Server Agent and with the specified name.
Public methodJob(JobServer, String, Int32)Initializes a new instance of the Job class on the specified instance of SQL Server Agent and with the specified name and category
Top

  NameDescription
Public propertyCategoryGets or sets the category to which the job belongs.
Public propertyCategoryIDGets the ID value that uniquely identifies the job category.
Public propertyCategoryTypeGets or sets the type of category, with respect to local or multiserver jobs.
Public propertyCurrentRunRetryAttemptGets the number of times Microsoft SQL Server Agent has attempted to run the job unsuccessfully.
Public propertyCurrentRunStatusGets the current execution status of the job.
Public propertyCurrentRunStepGets information about the job step that is currently running.
Public propertyDateCreatedGets the date and time when the job was created.
Public propertyDateLastModifiedGets the date and time when the job was last modified.
Public propertyDeleteLevelGets or sets the completion action that determines whether to delete the job definition when the job finishes execution.
Public propertyDescriptionGets or sets the textual description of the job.
Public propertyEmailLevelGets or sets the completion action that determines whether to send an e-mail notification to an operator when the job finishes execution.
Public propertyEventLogLevelGets or sets the completion action that determines whether to generate an operating system event log entry when the job finishes execution.
Protected propertyExecuteForScalarGets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.)
Public propertyHasScheduleGets the Boolean property value that specifies whether the job has at least one schedule.
Public propertyHasServerGets the Boolean property value that specifies whether the job has a target server assigned for multiple-server operations.
Public propertyHasStepGets the Boolean property value that specifies whether the job has at least one job step.
Public propertyIsEnabledGets or sets the Boolean property value that specifies whether the job is enabled.
Protected propertyIsTouchedGets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (Inherited from SqlSmoObject.)
Public propertyJobIDGets the job ID value.
Public propertyJobSchedulesGets a collection of JobSchedule objects that represent the schedules assigned to the job.
Public propertyJobStepsGets a collection of JobStep objects that represent the job steps defined for the job.
Public propertyJobTypeGets the job type, which specifies whether the job is local or multiserver.
Public propertyLastRunDateGets the date and time when the job was last run.
Public propertyLastRunOutcomeGets the result of the job from the last time it completed execution.
Public propertyNameGets or sets the name of the Job. (Overrides NamedSmoObject.Name.)
Public propertyNetSendLevelGets or sets the completion action that determines whether to net-send a notification to an operator when the job finishes execution.
Public propertyNextRunDateGets the date and time when the job is next scheduled to run.
Public propertyNextRunScheduleIDGets the ID value of the schedule that is responsible for the next execution of the job.
Protected propertyObjectInSpaceGets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public propertyOperatorToEmailGets or sets the operator that receives notification by e-mail when the job finishes execution.
Public propertyOperatorToNetSendGets or sets the operator that receives a net-send notification when the job finishes execution.
Public propertyOperatorToPageGets or sets the operator that receives a pager notification when the job finishes execution.
Public propertyOriginatingServerGets the name of the server that is acting as the master server in a multiserver job.
Public propertyOwnerLoginNameGets or sets the owner of the job.
Public propertyPageLevelGets or sets the completion action that determines whether to send a pager notification to an operator when the job finishes execution.
Public propertyParentGets or sets the JobServer object that is the parent of the Job object.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Protected propertyScalarResultGets the scalar result for the referenced object. (Inherited from SqlSmoObject.)
Public propertyStartStepIDGets or sets the ID value of the first job step in the sequence to be executed.
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.)
Public propertyVersionNumberGets a system-maintained value that is incremented every time the job is modified.
Top

  NameDescription
Protected methodAddDatabaseContext(StringCollection)Add the database context to the collection of queries identified by the queries parameter. (Inherited from SqlSmoObject.)
Protected methodAddDatabaseContext(StringCollection, ScriptingOptions)Add the database context to the collection of queries identified by the queries parameter, and using the specified scripting options. (Inherited from SqlSmoObject.)
Public methodAddSharedScheduleAdds a shared schedule to the Microsoft SQL Server Agent job.
Public methodAlterUpdates any Job object property changes on an instance of Microsoft SQL Server. 
Protected methodAlterImplActivates the object altered event. (Inherited from SqlSmoObject.)
Protected methodAlterImplFinishMethod called when object altered event finishes. (Inherited from SqlSmoObject.)
Protected methodAlterImplInitMethod called when object-altered event is intialized. (Inherited from SqlSmoObject.)
Protected methodAlterImplWorkerCalls the Alter methods. (Inherited from SqlSmoObject.)
Public methodApplyToTargetServerAdds a server to the list of target servers maintained for the referenced Microsoft SQL Server Agent job.
Public methodApplyToTargetServerGroupAdds one or more servers to the list of target servers maintained for the referenced Microsoft SQL Server Agent job.
Protected methodBindDefaultImplBinds the default items identified by the parameters. (Inherited from SqlSmoObject.)
Protected methodBindRuleImplBinds the rule schema to the rule and columns identified by the parameters. (Inherited from SqlSmoObject.)
Protected methodCheckCollationChecks the order of the scripting options by the collation method identified by the collationName parameter. (Inherited from SqlSmoObject.)
Protected methodCheckObjectState()Validates the state of the referenced object. (Inherited from SqlSmoObject.)
Protected methodCheckObjectState(Boolean)Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created. (Inherited from SqlSmoObject.)
Protected methodCheckObjectStateImplChecks the state of a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodCheckVersion100Checks whether version of SQL Server is SQL Server 2008. (Inherited from SqlSmoObject.)
Protected methodCheckVersion80Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.)
Protected methodCheckVersion80SP3Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.)
Protected methodCheckVersion90Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.)
Protected methodCheckVersionBelow90Checks whether version of SQL Server is before SQL Server 2005. (Inherited from SqlSmoObject.)
Protected methodCleanObjectSets the object to unmodified state. (Inherited from SqlSmoObject.)
Public methodCreateCreates a job on the instance of Microsoft SQL Server as defined by the Job object.
Protected methodCreateImplCreates an object with scripting options. (Inherited from SqlSmoObject.)
Protected methodCreateImplFinishMethod called when the create event finishes. (Inherited from SqlSmoObject.)
Protected methodCreateImplInitMethod called when the create event initializes. (Inherited from SqlSmoObject.)
Public methodDeleteJobStepLogs(DateTime)Deletes job step log files that are older than the specified date.
Public methodDeleteJobStepLogs(Int32)Deletes job step log files that are larger that the specified log ID number.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDrop()Removes an existing job.
Public methodDrop(Boolean)Removes an existing job.
Protected methodDropImplDrops a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodDropImplWorkerCalls the drop methods. (Inherited from SqlSmoObject.)
Public methodEnumAlertsEnumerates a list of Agent alerts that cause automated execution of the referenced job.
Public methodEnumHistory()Enumerates a list of execution history associated with the referenced job.
Public methodEnumHistory(JobHistoryFilter)Enumerates a list of execution history associated with the referenced job.
Public methodEnumJobStepLogs()Enumerates a list of job step log files for the referenced job.
Public methodEnumJobStepLogs(Int32)Enumerates a list of job step log files for the job step with the specified ID value.
Public methodEnumJobStepLogs(String)Enumerates a list of job step log files for the job step with the specified name.
Public methodEnumJobStepsByIDReturns an array of JobStep objects that belong to the referenced job and that are ordered by ID value.
Protected methodEnumScriptImplEnumerates scripts specified by the so parameter. (Inherited from SqlSmoObject.)
Protected methodEnumScriptImplWorkerCalls the methods that enumerate scripts specified by the so parameter. (Inherited from SqlSmoObject.)
Protected methodEnumScriptImplWorkerSOChangedReturns an IEnumerable string describing the scripting options for an object. (Inherited from SqlSmoObject.)
Public methodEnumTargetServersEnumerates a list of execution target servers that have been assigned to the referenced job.
Public methodEquals (Inherited from Object.)
Protected methodExecuteNonQueryExecutes a batch in the context of the database where there are no results returned. (Inherited from SqlSmoObject.)
Protected methodFinalize (Inherited from Object.)
Protected methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGenerateDataSpaceFileStreamScriptGenerates a script to create data file. (Inherited from SqlSmoObject.)
Protected methodGenerateDataSpaceScriptGenerates a script to allocate space in the data file. (Inherited from SqlSmoObject.)
Protected methodGetBindDefaultScriptGets the script that binds defaults specified by the defSchema and defName parameters. (Inherited from SqlSmoObject.)
Protected methodGetBindRuleScriptGets the script that specifies the binding rules. (Inherited from SqlSmoObject.)
Protected methodGetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32)Assigns a Boolean parameter of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodGetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32, Boolean)Assigns a Boolean property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodGetDateTimeParameterAssigns the datetime property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodGetDateTimeParameterAsIntAssigns the datetime property of the SqlSmoObject as an integer value if the datetime property is not null. (Inherited from SqlSmoObject.)
Protected methodGetDBNameDo not reference this member directly in your code. It supports the SQL Server infrastructure. Gets the database name that is associated with the object. (Inherited from AgentObjectBase.)
Protected methodGetEnumParameterAssigns an enumeration property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodGetFragOptionStringGets a FragmentationOption object as a string value. (Inherited from SqlSmoObject.)
Protected methodGetGuidParameterAssigns a Guid property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetParameter(StringBuilder, ScriptingOptions, String, String, Int32)Assigns a parameter of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodGetParameter(StringBuilder, ScriptingOptions, String, String, Int32, Boolean)Assigns a parameter of the SqlSmoObject. (Inherited from SqlSmoObject.)
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 methodGetRealValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetScriptingOptionsForCreateGets ScriptingOptions for the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerNameGets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetSqlServerVersionNameGets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected methodGetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32)Assigns a string parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32, Boolean)Assigns a string parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetTimeSpanParameterAsIntAssigns a time span parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGetType (Inherited from Object.)
Protected methodGetUrnRecursive(StringBuilder)Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetUrnRecursive(StringBuilder, UrnIdOption)Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodImplInitializeInitializes the fields of the SqlSmoObject object. (Inherited from SqlSmoObject.)
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.)
Public methodInvokeRuns the job.
Protected methodIsObjectDirtyVerifies whether the object properties have been modified and the changes have not yet been persisted on the instance of SQL Server. (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.)
Protected methodIsVersion80SP3Determines whether the version of SQL Server is SQL Server 2000 with SP3. (Inherited from SqlSmoObject.)
Protected methodIsVersion90AndAboveDetermines whether the version of SQL Server is SQL Server 2005 or later. (Inherited from SqlSmoObject.)
Protected methodMarkDroppedSets the SqlSmoState to dropped. (Inherited from SqlSmoObject.)
Protected methodMarkForDropImplSets the SqlSmoState to dropped. (Inherited from SqlSmoObject.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodPostAlterMethod activated after the SqlSmoObject is altered. (Inherited from SqlSmoObject.)
Protected methodPostCreateMethod activated after the SqlSmoObject is created. (Inherited from SqlSmoObject.)
Protected methodPostDropMethod activated after the SqlSmoObject is dropped. (Inherited from SqlSmoObject.)
Public methodPurgeHistoryRemoves system records maintaining execution history for the referenced job.
Public methodRefreshRefreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public methodRemoveAllJobSchedules()Removes all shared and unshared schedules from the job.
Public methodRemoveAllJobSchedules(Boolean)Removes all unused schedules from the job.
Public methodRemoveAllJobStepsRemoves all the job steps associated with the job.
Public methodRemoveFromTargetServerRemoves an execution target server from the list of target servers maintained for a job.
Public methodRemoveFromTargetServerGroupRemoves a group of execution target servers from the list of target servers maintained for a job.
Public methodRemoveSharedSchedule(Int32)Removes the specified shared schedule from the job.
Public methodRemoveSharedSchedule(Int32, Boolean)Removes the specified shared schedule from the job and keeps unused schedules.
Public methodRenameRenames the job.
Protected methodRenameImplIdentified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.)
Protected methodRenameImplWorkerIdentified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.)
Public methodScript()Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job.
Public methodScript(ScriptingOptions)Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job as specified by the scripting options.
Protected methodScriptAlterAlters the SqlSmoObject according to the parameters. (Inherited from SqlSmoObject.)
Protected methodScriptChangeOwnerThis method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Protected methodScriptCreateAlters the SqlSmoObject according to the parameters. (Inherited from SqlSmoObject.)
Protected methodScriptDdlThrows InvalidSmoOperationException. (Inherited from SqlSmoObject.)
Protected methodScriptDropThrows InvalidSmoOperationException. (Inherited from SqlSmoObject.)
Protected methodScriptImpl()Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodScriptImpl(ScriptingOptions)Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodScriptImplWorkerGets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodScriptOwnerAlters the script owner authorization. (Inherited from NamedSmoObject.)
Protected methodScriptRenameThis method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Protected methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Protected methodSetSchemaOwnedSets the schema owned value. (Inherited from NamedSmoObject.)
Public methodStart()Runs the referenced job.
Public methodStart(String)Runs the referenced job starting at the specified job step.
Public methodStopStops executing the referenced job.
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Protected methodTouchImplNot implemented. (Inherited from SqlSmoObject.)
Protected methodUnbindDefaultImplUnbinds the default columns of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodUnbindRuleImplUnbinds rules of the SqlSmoObject. (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
Protected fieldm_ExtendedPropertiesRepresents a property that is defined to extend the properties provided by a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected fieldsingletonParentRepresents the singleton parent. (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 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 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. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Top

To get or set Job 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, users must be a member of the SQLAgentUserRole, SQLAgentReaderRole, and SQLAgentOperatorRole database roles on the MSDB database, or be a member of the sysadmin fixed server role.

To drop a job, 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.

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.

Community Additions

ADD
Show:
© 2014 Microsoft