Job Job Job Class

Definition

Instance class encapsulating : Server[@Name='']/JobServer/Job

public sealed class Job : Microsoft.SqlServer.Management.Smo.Agent.AgentObjectBase, Microsoft.SqlServer.Management.Common.IAlterable, Microsoft.SqlServer.Management.Common.ICreatable, Microsoft.SqlServer.Management.Common.IDropIfExists, Microsoft.SqlServer.Management.Common.IDroppable, Microsoft.SqlServer.Management.Common.IRenamable, Microsoft.SqlServer.Management.Smo.IScriptable
type Job = class
    inherit AgentObjectBase
    interface IAlterable
    interface ICreatable
    interface IDroppable
    interface IDropIfExists
    interface IRenamable
    interface IScriptable
Public NotInheritable Class Job
Inherits AgentObjectBase
Implements IAlterable, ICreatable, IDropIfExists, IDroppable, IRenamable, IScriptable
Inheritance
Implements

Constructors

Job() Job() Job()
Job(JobServer, String) Job(JobServer, String) Job(JobServer, String)
Job(JobServer, String, Int32) Job(JobServer, String, Int32) Job(JobServer, String, Int32)

Properties

Category Category Category
CategoryID CategoryID CategoryID
CategoryType CategoryType CategoryType
CurrentRunRetryAttempt CurrentRunRetryAttempt CurrentRunRetryAttempt
CurrentRunStatus CurrentRunStatus CurrentRunStatus
CurrentRunStep CurrentRunStep CurrentRunStep
DatabaseEngineEdition DatabaseEngineEdition DatabaseEngineEdition

Returns the DatabaseEngineEdition of the SMO object

(Inherited from SqlSmoObject)
DatabaseEngineType DatabaseEngineType DatabaseEngineType

Returns the DatabaseEngineType of the SMO object

(Inherited from SqlSmoObject)
DateCreated DateCreated DateCreated
DateLastModified DateLastModified DateLastModified
DeleteLevel DeleteLevel DeleteLevel
Description Description Description
EmailLevel EmailLevel EmailLevel
EventLogLevel EventLogLevel EventLogLevel
ExecuteForScalar ExecuteForScalar ExecuteForScalar Inherited from SqlSmoObject
ExecutionManager ExecutionManager ExecutionManager Inherited from SqlSmoObject
HasSchedule HasSchedule HasSchedule
HasServer HasServer HasServer
HasStep HasStep HasStep
IsEnabled IsEnabled IsEnabled
IsTouched IsTouched IsTouched

Whether the object has been touched for unconditional scripting of Alter

(Inherited from SqlSmoObject)
JobID JobID JobID
JobSchedules JobSchedules JobSchedules

JobSchedules

JobSteps JobSteps JobSteps

JobSteps

JobType JobType JobType
LastRunDate LastRunDate LastRunDate
LastRunOutcome LastRunOutcome LastRunOutcome
Name Name Name
NetSendLevel NetSendLevel NetSendLevel
NextRunDate NextRunDate NextRunDate
NextRunScheduleID NextRunScheduleID NextRunScheduleID
ObjectInSpace ObjectInSpace ObjectInSpace Inherited from SqlSmoObject
OperatorToEmail OperatorToEmail OperatorToEmail
OperatorToNetSend OperatorToNetSend OperatorToNetSend
OperatorToPage OperatorToPage OperatorToPage
OriginatingServer OriginatingServer OriginatingServer
OwnerLoginName OwnerLoginName OwnerLoginName
PageLevel PageLevel PageLevel
Parent Parent Parent
Properties Properties Properties Inherited from SqlSmoObject
ScalarResult ScalarResult ScalarResult Inherited from SqlSmoObject
StartStepID StartStepID StartStepID
State State State

Returns the state of the object

(Inherited from SmoObjectBase)
Urn Urn Urn

Returns the Urn of the object, computed on the fly

(Inherited from SqlSmoObject)
UserData UserData UserData Inherited from SmoObjectBase
VersionNumber VersionNumber VersionNumber

Methods

AddDatabaseContext(StringCollection) AddDatabaseContext(StringCollection) AddDatabaseContext(StringCollection)

method get called from the create script related method (from derived classes like Table, Index etc..)

(Inherited from SqlSmoObject)
AddSharedSchedule(Int32) AddSharedSchedule(Int32) AddSharedSchedule(Int32)

AddSharedSchedule

Alter() Alter() Alter()

Alter

AlterImpl() AlterImpl() AlterImpl() Inherited from SqlSmoObject
AlterImplWorker() AlterImplWorker() AlterImplWorker() Inherited from SqlSmoObject
ApplyToTargetServer(String) ApplyToTargetServer(String) ApplyToTargetServer(String)

ApplyToTargetServer adds an execution target to the list of targets maintained for the referenced Agent job.

ApplyToTargetServerGroup(String) ApplyToTargetServerGroup(String) ApplyToTargetServerGroup(String)

ApplyToTargetServerGroup adds one or more execution targets to the list of targets maintained for the referenced Agent job.

BindDefaultImpl(String, String, Boolean) BindDefaultImpl(String, String, Boolean) BindDefaultImpl(String, String, Boolean) Inherited from SqlSmoObject
BindRuleImpl(String, String, Boolean) BindRuleImpl(String, String, Boolean) BindRuleImpl(String, String, Boolean) Inherited from SqlSmoObject
CheckObjectState() CheckObjectState() CheckObjectState() Inherited from SqlSmoObject
CheckObjectState(Boolean) CheckObjectState(Boolean) CheckObjectState(Boolean)

This is a virtual function, so that derived classes can override it if they want to do additional checks on the state of the object

(Inherited from SqlSmoObject)
CheckObjectStateImpl(Boolean) CheckObjectStateImpl(Boolean) CheckObjectStateImpl(Boolean)

Checks object state Because it is not recusrive, this function can be called directly and which means derived classes can't supply their own validation

(Inherited from SqlSmoObject)
CleanObject() CleanObject() CleanObject() Inherited from SqlSmoObject
Create() Create() Create()

Create

CreateImpl() CreateImpl() CreateImpl() Inherited from SqlSmoObject
CreateOrAlterImpl() CreateOrAlterImpl() CreateOrAlterImpl() Inherited from SqlSmoObject
DeleteJobStepLogs(DateTime) DeleteJobStepLogs(DateTime) DeleteJobStepLogs(DateTime)

Delete job step logs old than specified date

DeleteJobStepLogs(Int32) DeleteJobStepLogs(Int32) DeleteJobStepLogs(Int32)

Delete job step logs before certain log number

Discover() Discover() Discover()

Best Effort Discovery mechanism : This method reflects upon metadata and gets all available objects

(Inherited from SqlSmoObject)
Drop() Drop() Drop()

Drop

Drop(Boolean) Drop(Boolean) Drop(Boolean)

Drop

DropIfExists() DropIfExists() DropIfExists()

Drops the object with IF EXISTS option. If object is invalid for drop function will return without exception.

DropImpl(Boolean) DropImpl(Boolean) DropImpl(Boolean)

drops the object

(Inherited from SqlSmoObject)
DropImplWorker(Urn, Boolean) DropImplWorker(Urn, Boolean) DropImplWorker(Urn, Boolean)

drops the object

(Inherited from SqlSmoObject)
EnumAlerts() EnumAlerts() EnumAlerts()

This method returns a DataTable object that enumerates the Agent alerts that cause automated execution of the referenced job.

EnumHistory() EnumHistory() EnumHistory()

This method returns a DateTable object that enumerates the execution history of the referenced Agent job.

EnumHistory(JobHistoryFilter) EnumHistory(JobHistoryFilter) EnumHistory(JobHistoryFilter)

This method returns a DateTable object that enumerates the execution history of the referenced Agent job.

EnumJobStepLogs() EnumJobStepLogs() EnumJobStepLogs()

This method returns a DateTable object that enumerates the job step execution output logs if they were saved to the table

EnumJobStepLogs(Int32) EnumJobStepLogs(Int32) EnumJobStepLogs(Int32)

This method returns a DateTable object that enumerates the job step execution output logs if they were saved to the table filtering by step ID

EnumJobStepLogs(String) EnumJobStepLogs(String) EnumJobStepLogs(String)

This method returns a DateTable object that enumerates the job step execution output logs if they were saved to the table filtering by step name

EnumJobStepsByID() EnumJobStepsByID() EnumJobStepsByID()

EnumJobStepsByID

EnumTargetServers() EnumTargetServers() EnumTargetServers()

This method returns a DateTable object that enumerates the execution targets of the referenced Agent job.

ExecuteNonQuery(StringCollection, Boolean, Boolean) ExecuteNonQuery(StringCollection, Boolean, Boolean) ExecuteNonQuery(StringCollection, Boolean, Boolean)

Executes sql statements

(Inherited from SqlSmoObject)
ExecuteRenameQuery(String) ExecuteRenameQuery(String) ExecuteRenameQuery(String)

Creates the Rename query for a SqlSmoObject and Executes it on the Server.

(Inherited from NamedSmoObject)
ExecuteWithModes(SqlExecutionModes, Action) ExecuteWithModes(SqlExecutionModes, Action) ExecuteWithModes(SqlExecutionModes, Action)

Executes the given action under the given execution modes.

Resets the original modes after the action completes or fails.

(Inherited from SqlSmoObject)
FormatSqlVariant(Object) FormatSqlVariant(Object) FormatSqlVariant(Object) Inherited from SqlSmoObject
GenerateAlterEvent() GenerateAlterEvent() GenerateAlterEvent() Inherited from SqlSmoObject
GenerateAlterEvent(Urn, Object) GenerateAlterEvent(Urn, Object) GenerateAlterEvent(Urn, Object) Inherited from SqlSmoObject
GetContextDB() GetContextDB() GetContextDB() Inherited from SqlSmoObject
GetDBName() GetDBName() GetDBName() Inherited from AgentObjectBase
GetFragOptionString(FragmentationOption) GetFragOptionString(FragmentationOption) GetFragOptionString(FragmentationOption) Inherited from SqlSmoObject
GetPropValue(String) GetPropValue(String) GetPropValue(String)

Retrieve the property value from : - The property bag directly if property is available (dirty or retrieved) - A call to our OnPropertyMissing method otherwise

Will throw an exception if the property value is NULL in either case.

(Inherited from SqlSmoObject)
GetPropValueOptional(String) GetPropValueOptional(String) GetPropValueOptional(String)

Retrieve the property value from : - The property bag if the state is creating or we're in Design Mode (possible NULL value) - A call to our OnPropertyMissing method otherwise (will throw exception if value is NULL)

(Inherited from SqlSmoObject)
GetPropValueOptionalAllowNull(String) GetPropValueOptionalAllowNull(String) GetPropValueOptionalAllowNull(String)

Retrieve the property value from : - The property bag if the state is creating or we're in Design Mode (possible NULL) - A call to our OnPropertyMissing method otherwise (possible NULL)

(Inherited from SqlSmoObject)
GetRealValue(Property, Object) GetRealValue(Property, Object) GetRealValue(Property, Object)

Returns the real value for the property.

(Inherited from SqlSmoObject)
GetServerName() GetServerName() GetServerName() Inherited from SqlSmoObject
GetServerObject() GetServerObject() GetServerObject() Inherited from SqlSmoObject
GetSqlServerVersionName() GetSqlServerVersionName() GetSqlServerVersionName()

Gets the sqlserver public name for the current connection, e.g: will transfer "SQLTOOLS2008-2" to "SQL Server 2008".

(Inherited from SqlSmoObject)
GetUrnRecursive(StringBuilder) GetUrnRecursive(StringBuilder) GetUrnRecursive(StringBuilder)

Computes the Urn for the object.

(Inherited from SqlSmoObject)
GetUrnRecursive(StringBuilder, UrnIdOption) GetUrnRecursive(StringBuilder, UrnIdOption) GetUrnRecursive(StringBuilder, UrnIdOption)

Computes the Urn for the object, potentially including other fields in the definition besides the key fields.

(Inherited from SqlSmoObject)
ImplInitialize(String[], OrderBy[]) ImplInitialize(String[], OrderBy[]) ImplInitialize(String[], OrderBy[]) Inherited from SqlSmoObject
Initialize() Initialize() Initialize() Inherited from SqlSmoObject
Initialize(Boolean) Initialize(Boolean) Initialize(Boolean)

Initializes the object, by reading its properties from the enumerator

(Inherited from SqlSmoObject)
Invoke() Invoke() Invoke()

Executes the job.

IsExpressSku() IsExpressSku() IsExpressSku()

Returns whether the server containing this object is an Express SKU

(Inherited from SqlSmoObject)
IsObjectDirty() IsObjectDirty() IsObjectDirty() Inherited from SqlSmoObject
IsObjectInitialized() IsObjectInitialized() IsObjectInitialized() Inherited from SqlSmoObject
IsObjectInSpace() IsObjectInSpace() IsObjectInSpace() Inherited from SqlSmoObject
IsSupportedProperty(String) IsSupportedProperty(String) IsSupportedProperty(String)

Validate whether the specified property is supported in current server environment

(Inherited from SqlSmoObject)
IsVersion80SP3() IsVersion80SP3() IsVersion80SP3() Inherited from SqlSmoObject
IsVersion90AndAbove() IsVersion90AndAbove() IsVersion90AndAbove() Inherited from SqlSmoObject
MarkDropped() MarkDropped() MarkDropped() Inherited from SqlSmoObject
MarkForDropImpl(Boolean) MarkForDropImpl(Boolean) MarkForDropImpl(Boolean) Inherited from SqlSmoObject
PostAlter() PostAlter() PostAlter()

this function is meant to be overriden by derived classes, if they have to do supplimentary actions after altering the object

(Inherited from SqlSmoObject)
PostCreate() PostCreate() PostCreate()

this function is meant to be overriden by derived classes, if they have to do supplimentary actions after object creation

(Inherited from SqlSmoObject)
PostDrop() PostDrop() PostDrop()

this function is meant to be overriden by derived classes, if they have to do supplimentary actions after dropping the object

(Inherited from SqlSmoObject)
PurgeHistory() PurgeHistory() PurgeHistory()

This method removes system records maintaining execution history for the referenced Agent job.

Refresh() Refresh() Refresh()

refreshes the object's properties by reading them from the server

(Inherited from SqlSmoObject)
RemoveAllJobSchedules() RemoveAllJobSchedules() RemoveAllJobSchedules()

RemoveAllJobSchedules

RemoveAllJobSchedules(Boolean) RemoveAllJobSchedules(Boolean) RemoveAllJobSchedules(Boolean)

RemoveAllJobSchedules

RemoveAllJobSteps() RemoveAllJobSteps() RemoveAllJobSteps()

RemoveAllJobSteps

RemoveFromTargetServer(String) RemoveFromTargetServer(String) RemoveFromTargetServer(String)

RemoveFromTargetServer

RemoveFromTargetServerGroup(String) RemoveFromTargetServerGroup(String) RemoveFromTargetServerGroup(String)

RemoveFromTargetServerGroup

RemoveSharedSchedule(Int32) RemoveSharedSchedule(Int32) RemoveSharedSchedule(Int32)

RemoveSharedSchedule

RemoveSharedSchedule(Int32, Boolean) RemoveSharedSchedule(Int32, Boolean) RemoveSharedSchedule(Int32, Boolean)

RemoveSharedSchedule

Rename(String) Rename(String) Rename(String)

Rename

RenameImpl(String) RenameImpl(String) RenameImpl(String)

change object name

(Inherited from NamedSmoObject)
RenameImplWorker(String) RenameImplWorker(String) RenameImplWorker(String) Inherited from NamedSmoObject
Script() Script() Script()

Generate object creation script using default scripting options

Script(ScriptingOptions) Script(ScriptingOptions) Script(ScriptingOptions)

Script object with specific scripting options

ScriptImpl() ScriptImpl() ScriptImpl() Inherited from SqlSmoObject
ScriptImpl(ScriptingOptions) ScriptImpl(ScriptingOptions) ScriptImpl(ScriptingOptions)

Returns a StringCollection object with the script for the object. This method throws an error if ScriptData is true

(Inherited from SqlSmoObject)
SetAccessToken(IRenewableToken) SetAccessToken(IRenewableToken) SetAccessToken(IRenewableToken)

Set the accessToken for connection.

(Inherited from SqlSmoObject)
SetParentImpl(SqlSmoObject) SetParentImpl(SqlSmoObject) SetParentImpl(SqlSmoObject) Inherited from SqlSmoObject
SetSchemaOwned() SetSchemaOwned() SetSchemaOwned() Inherited from NamedSmoObject
Start() Start() Start()

Start

Start(String) Start(String) Start(String)

Start

Stop() Stop() Stop()

Stop

ThrowIfAboveVersion100(String) ThrowIfAboveVersion100(String) ThrowIfAboveVersion100(String)

Throws an exception if the ServerVersion major version for this object is above 10.0 (SQL 2008)

(Inherited from SqlSmoObject)
ThrowIfAboveVersion80(String) ThrowIfAboveVersion80(String) ThrowIfAboveVersion80(String)

Throws an exception if the ServerVersion major version for this object is above 8.0 (SQL 2000)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion100(String) ThrowIfBelowVersion100(String) ThrowIfBelowVersion100(String)

Throws an exception if the ServerVersion major version for this object is below 10.0 (SQL 2008)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion110(String) ThrowIfBelowVersion110(String) ThrowIfBelowVersion110(String)

Throws an UnsupportedVersionException if either the source or destination server is below 11.0 (SQL 2012)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion110Prop(String) ThrowIfBelowVersion110Prop(String) ThrowIfBelowVersion110Prop(String)

Throws an exception with text saying the specified property is not supported if the ServerVersion major version for this object is below 11.0 (SQL 2012)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion120(String) ThrowIfBelowVersion120(String) ThrowIfBelowVersion120(String)

Throws an exception if the ServerVersion major version for this object is below 12.0 (SQL 2014)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion120Prop(String) ThrowIfBelowVersion120Prop(String) ThrowIfBelowVersion120Prop(String)

Throws an exception with text saying the specified property is not supported if the ServerVersion major version for this object is below 12.0 (SQL 2014)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion130(String) ThrowIfBelowVersion130(String) ThrowIfBelowVersion130(String)

Throws an exception if the ServerVersion major version for this object is below 13.0 (SQL 2016)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion130Prop(String) ThrowIfBelowVersion130Prop(String) ThrowIfBelowVersion130Prop(String)

Throws an exception with text saying the specified property is not supported if the ServerVersion major version for this object is below 13.0 (SQL 2016)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion140(String) ThrowIfBelowVersion140(String) ThrowIfBelowVersion140(String)

Throws an exception if the ServerVersion major version for this object is below 14.0 (SQL 2017)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion140Prop(String) ThrowIfBelowVersion140Prop(String) ThrowIfBelowVersion140Prop(String)

Throws an exception with text saying the specified property is not supported if the ServerVersion major version for this object is below 14.0 (SQL 2017)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion80(String) ThrowIfBelowVersion80(String) ThrowIfBelowVersion80(String)

Throws an exception if the ServerVersion major version for this object is below 8.0 (SQL 2000)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion80SP3() ThrowIfBelowVersion80SP3() ThrowIfBelowVersion80SP3()

Throws an exception if the ServerVersion for this object is below 8.760 (8.0 SP3)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion90(String) ThrowIfBelowVersion90(String) ThrowIfBelowVersion90(String)

Throws an exception if the ServerVersion major version for this object is below 9.0 (SQL 2005)

(Inherited from SqlSmoObject)
ToString() ToString() ToString() Inherited from SqlSmoObject
Touch() Touch() Touch()

Mark the object "touched" for unconditional scripting of Alter.

(Inherited from SqlSmoObject)
TouchImpl() TouchImpl() TouchImpl()

Virtual method to allow derived classes to do additional work when touched.

(Inherited from SqlSmoObject)
UnbindDefaultImpl(Boolean) UnbindDefaultImpl(Boolean) UnbindDefaultImpl(Boolean) Inherited from SqlSmoObject
UnbindRuleImpl(Boolean) UnbindRuleImpl(Boolean) UnbindRuleImpl(Boolean) Inherited from SqlSmoObject
Validate(String, Object[]) Validate(String, Object[]) Validate(String, Object[]) Inherited from SmoObjectBase

Fields

m_ExtendedProperties m_ExtendedProperties m_ExtendedProperties Inherited from SqlSmoObject
singletonParent singletonParent singletonParent

Regular SMO objects access the parent class reference through parentColl (corresponding collection in parent class). Singleton class has no collection in parent.

(Inherited from SqlSmoObject)

Explicit Interface Implementations

IAlienObject.Discover() IAlienObject.Discover() IAlienObject.Discover() Inherited from SqlSmoObject
IAlienObject.GetDomainRoot() IAlienObject.GetDomainRoot() IAlienObject.GetDomainRoot() Inherited from SqlSmoObject
IAlienObject.GetParent() IAlienObject.GetParent() IAlienObject.GetParent() Inherited from SqlSmoObject
IAlienObject.GetPropertyType(String) IAlienObject.GetPropertyType(String) IAlienObject.GetPropertyType(String)

Discovers type of property.

(Inherited from SqlSmoObject)
IAlienObject.GetPropertyValue(String, Type) IAlienObject.GetPropertyValue(String, Type) IAlienObject.GetPropertyValue(String, Type)

Retrieves value for a given property. Throws if property is not found.

(Inherited from SqlSmoObject)
IAlienObject.GetUrn() IAlienObject.GetUrn() IAlienObject.GetUrn() Inherited from SqlSmoObject
IAlienObject.Resolve(String) IAlienObject.Resolve(String) IAlienObject.Resolve(String) Inherited from SqlSmoObject
IAlienObject.SetObjectState(SfcObjectState) IAlienObject.SetObjectState(SfcObjectState) IAlienObject.SetObjectState(SfcObjectState)

Sets state of this object based on provided SfcObjectState.

(Inherited from SqlSmoObject)
IAlienObject.SetPropertyValue(String, Type, Object) IAlienObject.SetPropertyValue(String, Type, Object) IAlienObject.SetPropertyValue(String, Type, Object)

Sets the value of given property, if it is writable. If property is not in property bag, reflection is used. Throws exception if the property is not found.

(Inherited from SqlSmoObject)
ISfcPropertyProvider.GetPropertySet() ISfcPropertyProvider.GetPropertySet() ISfcPropertyProvider.GetPropertySet() Inherited from SqlSmoObject

Events

PropertyChanged PropertyChanged PropertyChanged Inherited from SqlSmoObject
PropertyMetadataChanged PropertyMetadataChanged PropertyMetadataChanged Inherited from SqlSmoObject

Applies to