• Article

Job Members

Include Protected Members
Include Inherited Members

The Job class represents a Microsoft SQL Server Agent job.

The Job type exposes the following members.

Constructors

  Name Description
Public method Job() Initializes a new instance of the Job class.
Public method Job(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 method Job(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

Methods

  Name Description
Protected method AddDatabaseContext(StringCollection) (Inherited from SqlSmoObject.)
Public method AddSharedSchedule(Int32) Adds a shared schedule to the Microsoft SQL Server Agent job.
Public method Alter() Updates any Job object property changes on an instance of Microsoft SQL Server. 
Protected method AlterImpl() (Inherited from SqlSmoObject.)
Protected method AlterImplFinish(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method AlterImplInit(StringCollection%, ScriptingOptions%) (Inherited from SqlSmoObject.)
Protected method AlterImplWorker() (Inherited from SqlSmoObject.)
Public method ApplyToTargetServer(String) Adds a server to the list of target servers maintained for the referenced Microsoft SQL Server Agent job.
Public method ApplyToTargetServerGroup(String) Adds one or more servers to the list of target servers maintained for the referenced Microsoft SQL Server Agent job.
Protected method BindDefaultImpl(String, String, Boolean) (Inherited from SqlSmoObject.)
Protected method BindRuleImpl(String, String, Boolean) (Inherited from SqlSmoObject.)
Protected method CheckCollation(String, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method CheckObjectState() Validates the state of the referenced object. (Inherited from SqlSmoObject.)
Protected method CheckObjectState(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 method CheckObjectStateImpl(Boolean) (Inherited from SqlSmoObject.)
Protected method CheckVersion100() (Inherited from SqlSmoObject.)
Protected method CheckVersion80() Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.)
Protected method CheckVersion80SP3() Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.)
Protected method CheckVersion90() Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.)
Protected method CheckVersionBelow90() (Inherited from SqlSmoObject.)
Protected method CleanObject() (Inherited from SqlSmoObject.)
Public method Create() Creates a job on the instance of Microsoft SQL Server as defined by the Job object.
Protected method CreateImpl() (Inherited from SqlSmoObject.)
Protected method CreateImplFinish(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method CreateImplInit(StringCollection%, ScriptingOptions%) (Inherited from SqlSmoObject.)
Public method DeleteJobStepLogs(DateTime) Deletes job step log files that are older than the specified date.
Public method DeleteJobStepLogs(Int32) Deletes job step log files that are larger that the specified log ID number.
Public method Discover() (Inherited from SqlSmoObject.)
Public method Drop() Removes an existing job.
Public method Drop(Boolean) Removes an existing job.
Protected method DropImpl() (Inherited from SqlSmoObject.)
Protected method DropImplWorker(Urn%) (Inherited from SqlSmoObject.)
Public method EnumAlerts() Enumerates a list of Agent alerts that cause automated execution of the referenced job.
Public method EnumHistory() Enumerates a list of execution history associated with the referenced job.
Public method EnumHistory(JobHistoryFilter) Enumerates a list of execution history associated with the referenced job.
Public method EnumJobStepLogs() Enumerates a list of job step log files for the referenced job.
Public method EnumJobStepLogs(Int32) Enumerates a list of job step log files for the job step with the specified ID value.
Public method EnumJobStepLogs(String) Enumerates a list of job step log files for the job step with the specified name.
Public method EnumJobStepsByID() Returns an array of JobStep objects that belong to the referenced job and that are ordered by ID value.
Protected method EnumScriptImpl(ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method EnumScriptImplWorker(ScriptingOptions) (Inherited from SqlSmoObject.)
Public method EnumTargetServers() Enumerates a list of execution target servers that have been assigned to the referenced job.
Public method Equals(Object) (Inherited from Object.)
Protected method Finalize() (Inherited from Object.)
Protected method FormatSqlVariant(Object) (Inherited from SqlSmoObject.)
Protected method GenerateDataSpaceFileStreamScript(StringBuilder, ScriptingOptions, Boolean) (Inherited from SqlSmoObject.)
Protected method GenerateDataSpaceScript(StringBuilder, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method GetBindDefaultScript(ScriptingOptions, String, String, Boolean) (Inherited from SqlSmoObject.)
Protected method GetBindRuleScript(ScriptingOptions, String, String, Boolean) (Inherited from SqlSmoObject.)
Protected method GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Protected method GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) (Inherited from SqlSmoObject.)
Protected method GetDateTimeParameter(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Protected method GetDateTimeParameterAsInt(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Protected method GetDBName() Gets the database name that is associated with the object. (Inherited from AgentObjectBase.)
Protected method GetEnumParameter(StringBuilder, ScriptingOptions, String, String, Type, Int32%) (Inherited from SqlSmoObject.)
Protected method GetFragOptionString(FragmentationOption) (Inherited from SqlSmoObject.)
Protected method GetGuidParameter(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Public method GetHashCode() (Inherited from Object.)
Protected method GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Protected method GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) (Inherited from SqlSmoObject.)
Protected method GetPropValue(String) (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional(String) (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull(String) (Inherited from SqlSmoObject.)
Protected method GetRealValue(Property, Object) (Inherited from SqlSmoObject.)
Protected method GetScriptingOptionsForCreate() (Inherited from SqlSmoObject.)
Protected method GetServerName() Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected method GetServerObject() (Inherited from SqlSmoObject.)
Protected method GetSqlServerVersionName() Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected method GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Protected method GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) (Inherited from SqlSmoObject.)
Protected method GetTimeSpanParameterAsInt(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Public method GetType() (Inherited from Object.)
Protected method GetUrnRecursive(StringBuilder) (Inherited from SqlSmoObject.)
Protected method GetUrnRecursive(StringBuilder, UrnIdOption) (Inherited from SqlSmoObject.)
Protected method ImplInitialize(array<String[], array<OrderBy[]) (Inherited from SqlSmoObject.)
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.)
Public method Invoke() Runs the job.
Protected method IsObjectDirty() Verifies 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 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.)
Protected method IsVersion80SP3() (Inherited from SqlSmoObject.)
Protected method MarkDropped() (Inherited from SqlSmoObject.)
Protected method MarkForDropImpl(Boolean) (Inherited from SqlSmoObject.)
Protected method MemberwiseClone() (Inherited from Object.)
Protected method PostAlter() (Inherited from SqlSmoObject.)
Protected method PostCreate() (Inherited from SqlSmoObject.)
Protected method PostDrop() (Inherited from SqlSmoObject.)
Public method PurgeHistory() Removes system records maintaining execution history for the referenced job.
Public method Refresh() Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public method RemoveAllJobSchedules() Removes all shared and unshared schedules from the job.
Public method RemoveAllJobSchedules(Boolean) Removes all shared and unshared schedules from the job.
Public method RemoveAllJobSteps() Removes all the job steps associated with the job.
Public method RemoveFromTargetServer(String) Removes an execution target server from the list of target servers maintained for a job.
Public method RemoveFromTargetServerGroup(String) Removes a group of execution target servers from the list of target servers maintained for a job.
Public method RemoveSharedSchedule(Int32) Removes the specified shared schedule from the job.
Public method RemoveSharedSchedule(Int32, Boolean) Removes the specified shared schedule from the job and keeps unused schedules.
Public method Rename(String) Renames the job.
Protected method RenameImpl(String) This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Protected method RenameImplWorker(String) This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Public method Script() Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job.
Public method Script(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 method ScriptAlter(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method ScriptChangeOwner(StringCollection, ScriptingOptions) This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Protected method ScriptCreate(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method ScriptDdl(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method ScriptDrop(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method ScriptImpl() (Inherited from SqlSmoObject.)
Protected method ScriptImpl(ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method ScriptImplWorker(ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method ScriptRename(StringCollection, ScriptingOptions, String) This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Protected method SetParentImpl(SqlSmoObject) (Inherited from SqlSmoObject.)
Public method Start() Runs the referenced job.
Public method Start(String) Runs the referenced job starting at the specified job step.
Public method Stop() Stops executing the referenced job.
Public method ToString() Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Protected method TouchImpl() (Inherited from SqlSmoObject.)
Protected method UnbindDefaultImpl(Boolean) (Inherited from SqlSmoObject.)
Protected method UnbindRuleImpl(Boolean) (Inherited from SqlSmoObject.)
Public method Validate(String, array<Object[]) (Inherited from SmoObjectBase.)

Top

Fields

  Name Description
Protected field m_ExtendedProperties (Inherited from SqlSmoObject.)

Top

Properties

  Name Description
Public property Category Gets or sets the category to which the job belongs.
Public property CategoryID Gets the ID value that uniquely identifies the job category.
Public property CategoryType Gets or sets the type of category, with respect to local or multiserver jobs.
Public property CurrentRunRetryAttempt Gets the number of times Microsoft SQL Server Agent has attempted to run the job unsuccessfully.
Public property CurrentRunStatus Gets the current execution status of the job.
Public property CurrentRunStep Gets information about the job step that is currently running.
Public property DateCreated Gets the date and time when the job was created.
Public property DateLastModified Gets the date and time when the job was last modified.
Public property DeleteLevel Gets or sets the completion action that determines whether to delete the job definition when the job finishes execution.
Public property Description Gets or sets the textual description of the job.
Public property EmailLevel Gets or sets the completion action that determines whether to send an e-mail notification to an operator when the job finishes execution.
Public property EventLogLevel Gets or sets the completion action that determines whether to generate an operating system event log entry when the job finishes execution.
Protected property ExecuteForScalar Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.)
Public property HasSchedule Gets the Boolean property value that specifies whether the job has at least one schedule.
Public property HasServer Gets the Boolean property value that specifies whether the job has a target server assigned for multiple-server operations.
Public property HasStep Gets the Boolean property value that specifies whether the job has at least one job step.
Public property IsEnabled Gets or sets the Boolean property value that specifies whether the job is enabled.
Protected property IsTouched Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (Inherited from SqlSmoObject.)
Public property JobID Gets or sets the job ID value.
Public property JobSchedules Gets a collection of JobSchedule objects that represent the schedules assigned to the job.
Public property JobSteps Gets a collection of JobStep objects that represent the job steps defined for the job.
Public property JobType Gets the job type, which specifies whether the job is local or multiserver.
Public property LastRunDate Gets the date and time when the job was last run.
Public property LastRunOutcome Gets the result of the job from the last time it completed execution.
Public property Name (Overrides NamedSmoObject.Name.)
Public property NetSendLevel Gets or sets the completion action that determines whether to net-send a notification to an operator when the job finishes execution.
Public property NextRunDate Gets the date and time when the job is next scheduled to run.
Public property NextRunScheduleID Gets the ID value of the schedule that is responsible for the next execution of the job.
Protected property ObjectInSpace Gets 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 property OperatorToEmail Gets or sets the operator that receives notification by e-mail when the job finishes execution.
Public property OperatorToNetSend Gets or sets the operator that receives a net-send notification when the job finishes execution.
Public property OperatorToPage Gets or sets the operator that receives a pager notification when the job finishes execution.
Public property OriginatingServer Gets the name of the server that is acting as the master server in a multiserver job.
Public property OwnerLoginName Gets or sets the owner of the job.
Public property PageLevel Gets or sets the completion action that determines whether to send a pager notification to an operator when the job finishes execution.
Public property Parent Gets or sets the JobServer object that is the parent of the Job object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Protected property ScalarResult Gets the scalar result for the referenced object. (Inherited from SqlSmoObject.)
Public property StartStepID Gets or sets the ID value of the first job step in the sequence to be executed.
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.)
Public property VersionNumber Gets a system-maintained value that is incremented every time the job is modified.

Top

Events

  Name Description
Public event PropertyChanged (Inherited from SqlSmoObject.)
Public event PropertyMetadataChanged (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObjectDiscover() (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObjectGetParent() (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObjectGetProperty(String) (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProviderGetPropertySet() (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObjectGetUrn() (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObjectResolve(String) (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObjectSetProperty(Object, Object) (Inherited from SqlSmoObject.)

Top