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 | |
---|---|---|
![]() |
Job() | Initializes a new instance of the Job class. |
![]() |
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. |
![]() |
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 | |
---|---|---|
![]() |
AddDatabaseContext(StringCollection) | (Inherited from SqlSmoObject.) |
![]() |
AddSharedSchedule(Int32) | Adds a shared schedule to the Microsoft SQL Server Agent job. |
![]() |
Alter() | Updates any Job object property changes on an instance of Microsoft SQL Server. |
![]() |
AlterImpl() | (Inherited from SqlSmoObject.) |
![]() |
AlterImplFinish(StringCollection, ScriptingOptions) | (Inherited from SqlSmoObject.) |
![]() |
AlterImplInit(StringCollection%, ScriptingOptions%) | (Inherited from SqlSmoObject.) |
![]() |
AlterImplWorker() | (Inherited from SqlSmoObject.) |
![]() |
ApplyToTargetServer(String) | Adds a server to the list of target servers maintained for the referenced Microsoft SQL Server Agent job. |
![]() |
ApplyToTargetServerGroup(String) | Adds one or more servers to the list of target servers maintained for the referenced Microsoft SQL Server Agent job. |
![]() |
BindDefaultImpl(String, String, Boolean) | (Inherited from SqlSmoObject.) |
![]() |
BindRuleImpl(String, String, Boolean) | (Inherited from SqlSmoObject.) |
![]() |
CheckCollation(String, ScriptingOptions) | (Inherited from SqlSmoObject.) |
![]() |
CheckObjectState() | Validates the state of the referenced object. (Inherited from SqlSmoObject.) |
![]() |
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.) |
![]() |
CheckObjectStateImpl(Boolean) | (Inherited from SqlSmoObject.) |
![]() |
CheckVersion100() | (Inherited from SqlSmoObject.) |
![]() |
CheckVersion80() | Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.) |
![]() |
CheckVersion80SP3() | Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.) |
![]() |
CheckVersion90() | Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.) |
![]() |
CheckVersionBelow90() | (Inherited from SqlSmoObject.) |
![]() |
CleanObject() | (Inherited from SqlSmoObject.) |
![]() |
Create() | Creates a job on the instance of Microsoft SQL Server as defined by the Job object. |
![]() |
CreateImpl() | (Inherited from SqlSmoObject.) |
![]() |
CreateImplFinish(StringCollection, ScriptingOptions) | (Inherited from SqlSmoObject.) |
![]() |
CreateImplInit(StringCollection%, ScriptingOptions%) | (Inherited from SqlSmoObject.) |
![]() |
DeleteJobStepLogs(DateTime) | Deletes job step log files that are older than the specified date. |
![]() |
DeleteJobStepLogs(Int32) | Deletes job step log files that are larger that the specified log ID number. |
![]() |
Discover() | (Inherited from SqlSmoObject.) |
![]() |
Drop() | Removes an existing job. |
![]() |
Drop(Boolean) | Removes an existing job. |
![]() |
DropImpl() | (Inherited from SqlSmoObject.) |
![]() |
DropImplWorker(Urn%) | (Inherited from SqlSmoObject.) |
![]() |
EnumAlerts() | Enumerates a list of Agent alerts that cause automated execution of the referenced job. |
![]() |
EnumHistory() | Enumerates a list of execution history associated with the referenced job. |
![]() |
EnumHistory(JobHistoryFilter) | Enumerates a list of execution history associated with the referenced job. |
![]() |
EnumJobStepLogs() | Enumerates a list of job step log files for the referenced job. |
![]() |
EnumJobStepLogs(Int32) | Enumerates a list of job step log files for the job step with the specified ID value. |
![]() |
EnumJobStepLogs(String) | Enumerates a list of job step log files for the job step with the specified name. |
![]() |
EnumJobStepsByID() | Returns an array of JobStep objects that belong to the referenced job and that are ordered by ID value. |
![]() |
EnumScriptImpl(ScriptingOptions) | (Inherited from SqlSmoObject.) |
![]() |
EnumScriptImplWorker(ScriptingOptions) | (Inherited from SqlSmoObject.) |
![]() |
EnumTargetServers() | Enumerates a list of execution target servers that have been assigned to the referenced job. |
![]() |
Equals(Object) | (Inherited from Object.) |
![]() |
Finalize() | (Inherited from Object.) |
![]() |
FormatSqlVariant(Object) | (Inherited from SqlSmoObject.) |
![]() |
GenerateDataSpaceFileStreamScript(StringBuilder, ScriptingOptions, Boolean) | (Inherited from SqlSmoObject.) |
![]() |
GenerateDataSpaceScript(StringBuilder, ScriptingOptions) | (Inherited from SqlSmoObject.) |
![]() |
GetBindDefaultScript(ScriptingOptions, String, String, Boolean) | (Inherited from SqlSmoObject.) |
![]() |
GetBindRuleScript(ScriptingOptions, String, String, Boolean) | (Inherited from SqlSmoObject.) |
![]() |
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | (Inherited from SqlSmoObject.) |
![]() |
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | (Inherited from SqlSmoObject.) |
![]() |
GetDateTimeParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | (Inherited from SqlSmoObject.) |
![]() |
GetDateTimeParameterAsInt(StringBuilder, ScriptingOptions, String, String, Int32%) | (Inherited from SqlSmoObject.) |
![]() |
GetDBName() | Gets the database name that is associated with the object. (Inherited from AgentObjectBase.) |
![]() |
GetEnumParameter(StringBuilder, ScriptingOptions, String, String, Type, Int32%) | (Inherited from SqlSmoObject.) |
![]() |
GetFragOptionString(FragmentationOption) | (Inherited from SqlSmoObject.) |
![]() |
GetGuidParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | (Inherited from SqlSmoObject.) |
![]() |
GetHashCode() | (Inherited from Object.) |
![]() |
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | (Inherited from SqlSmoObject.) |
![]() |
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | (Inherited from SqlSmoObject.) |
![]() |
GetPropValue(String) | (Inherited from SqlSmoObject.) |
![]() |
GetPropValueOptional(String) | (Inherited from SqlSmoObject.) |
![]() |
GetPropValueOptionalAllowNull(String) | (Inherited from SqlSmoObject.) |
![]() |
GetRealValue(Property, Object) | (Inherited from SqlSmoObject.) |
![]() |
GetScriptingOptionsForCreate() | (Inherited from SqlSmoObject.) |
![]() |
GetServerName() | Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.) |
![]() |
GetServerObject() | (Inherited from SqlSmoObject.) |
![]() |
GetSqlServerVersionName() | Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.) |
![]() |
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | (Inherited from SqlSmoObject.) |
![]() |
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | (Inherited from SqlSmoObject.) |
![]() |
GetTimeSpanParameterAsInt(StringBuilder, ScriptingOptions, String, String, Int32%) | (Inherited from SqlSmoObject.) |
![]() |
GetType() | (Inherited from Object.) |
![]() |
GetUrnRecursive(StringBuilder) | (Inherited from SqlSmoObject.) |
![]() |
GetUrnRecursive(StringBuilder, UrnIdOption) | (Inherited from SqlSmoObject.) |
![]() |
ImplInitialize(array<String[], array<OrderBy[]) | (Inherited from SqlSmoObject.) |
![]() |
Initialize() | Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.) |
![]() |
Initialize(Boolean) | Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.) |
![]() |
Invoke() | Runs the job. |
![]() |
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.) |
![]() |
IsObjectInitialized() | Verifies whether the object has been initialized. (Inherited from SqlSmoObject.) |
![]() |
IsObjectInSpace() | Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.) |
![]() |
IsVersion80SP3() | (Inherited from SqlSmoObject.) |
![]() |
MarkDropped() | (Inherited from SqlSmoObject.) |
![]() |
MarkForDropImpl(Boolean) | (Inherited from SqlSmoObject.) |
![]() |
MemberwiseClone() | (Inherited from Object.) |
![]() |
PostAlter() | (Inherited from SqlSmoObject.) |
![]() |
PostCreate() | (Inherited from SqlSmoObject.) |
![]() |
PostDrop() | (Inherited from SqlSmoObject.) |
![]() |
PurgeHistory() | Removes system records maintaining execution history for the referenced job. |
![]() |
Refresh() | Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.) |
![]() |
RemoveAllJobSchedules() | Removes all shared and unshared schedules from the job. |
![]() |
RemoveAllJobSchedules(Boolean) | Removes all shared and unshared schedules from the job. |
![]() |
RemoveAllJobSteps() | Removes all the job steps associated with the job. |
![]() |
RemoveFromTargetServer(String) | Removes an execution target server from the list of target servers maintained for a job. |
![]() |
RemoveFromTargetServerGroup(String) | Removes a group of execution target servers from the list of target servers maintained for a job. |
![]() |
RemoveSharedSchedule(Int32) | Removes the specified shared schedule from the job. |
![]() |
RemoveSharedSchedule(Int32, Boolean) | Removes the specified shared schedule from the job and keeps unused schedules. |
![]() |
Rename(String) | Renames the job. |
![]() |
RenameImpl(String) | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.) |
![]() |
RenameImplWorker(String) | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.) |
![]() |
Script() | Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job. |
![]() |
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. |
![]() |
ScriptAlter(StringCollection, ScriptingOptions) | (Inherited from SqlSmoObject.) |
![]() |
ScriptChangeOwner(StringCollection, ScriptingOptions) | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.) |
![]() |
ScriptCreate(StringCollection, ScriptingOptions) | (Inherited from SqlSmoObject.) |
![]() |
ScriptDdl(StringCollection, ScriptingOptions) | (Inherited from SqlSmoObject.) |
![]() |
ScriptDrop(StringCollection, ScriptingOptions) | (Inherited from SqlSmoObject.) |
![]() |
ScriptImpl() | (Inherited from SqlSmoObject.) |
![]() |
ScriptImpl(ScriptingOptions) | (Inherited from SqlSmoObject.) |
![]() |
ScriptImplWorker(ScriptingOptions) | (Inherited from SqlSmoObject.) |
![]() |
ScriptRename(StringCollection, ScriptingOptions, String) | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.) |
![]() |
SetParentImpl(SqlSmoObject) | (Inherited from SqlSmoObject.) |
![]() |
Start() | Runs the referenced job. |
![]() |
Start(String) | Runs the referenced job starting at the specified job step. |
![]() |
Stop() | Stops executing the referenced job. |
![]() |
ToString() | Returns a String that represents the referenced object. (Inherited from SqlSmoObject.) |
![]() |
TouchImpl() | (Inherited from SqlSmoObject.) |
![]() |
UnbindDefaultImpl(Boolean) | (Inherited from SqlSmoObject.) |
![]() |
UnbindRuleImpl(Boolean) | (Inherited from SqlSmoObject.) |
![]() |
Validate(String, array<Object[]) | (Inherited from SmoObjectBase.) |
Top
Properties
Name | Description | |
---|---|---|
![]() |
Category | Gets or sets the category to which the job belongs. |
![]() |
CategoryID | Gets the ID value that uniquely identifies the job category. |
![]() |
CategoryType | Gets or sets the type of category, with respect to local or multiserver jobs. |
![]() |
CurrentRunRetryAttempt | Gets the number of times Microsoft SQL Server Agent has attempted to run the job unsuccessfully. |
![]() |
CurrentRunStatus | Gets the current execution status of the job. |
![]() |
CurrentRunStep | Gets information about the job step that is currently running. |
![]() |
DateCreated | Gets the date and time when the job was created. |
![]() |
DateLastModified | Gets the date and time when the job was last modified. |
![]() |
DeleteLevel | Gets or sets the completion action that determines whether to delete the job definition when the job finishes execution. |
![]() |
Description | Gets or sets the textual description of the job. |
![]() |
EmailLevel | Gets or sets the completion action that determines whether to send an e-mail notification to an operator when the job finishes execution. |
![]() |
EventLogLevel | Gets or sets the completion action that determines whether to generate an operating system event log entry when the job finishes execution. |
![]() |
ExecuteForScalar | Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.) |
![]() |
HasSchedule | Gets the Boolean property value that specifies whether the job has at least one schedule. |
![]() |
HasServer | Gets the Boolean property value that specifies whether the job has a target server assigned for multiple-server operations. |
![]() |
HasStep | Gets the Boolean property value that specifies whether the job has at least one job step. |
![]() |
IsEnabled | Gets or sets the Boolean property value that specifies whether the job is enabled. |
![]() |
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.) |
![]() |
JobID | Gets or sets the job ID value. |
![]() |
JobSchedules | Gets a collection of JobSchedule objects that represent the schedules assigned to the job. |
![]() |
JobSteps | Gets a collection of JobStep objects that represent the job steps defined for the job. |
![]() |
JobType | Gets the job type, which specifies whether the job is local or multiserver. |
![]() |
LastRunDate | Gets the date and time when the job was last run. |
![]() |
LastRunOutcome | Gets the result of the job from the last time it completed execution. |
![]() |
Name | (Overrides NamedSmoObject.Name.) |
![]() |
NetSendLevel | Gets or sets the completion action that determines whether to net-send a notification to an operator when the job finishes execution. |
![]() |
NextRunDate | Gets the date and time when the job is next scheduled to run. |
![]() |
NextRunScheduleID | Gets the ID value of the schedule that is responsible for the next execution of the job. |
![]() |
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.) |
![]() |
OperatorToEmail | Gets or sets the operator that receives notification by e-mail when the job finishes execution. |
![]() |
OperatorToNetSend | Gets or sets the operator that receives a net-send notification when the job finishes execution. |
![]() |
OperatorToPage | Gets or sets the operator that receives a pager notification when the job finishes execution. |
![]() |
OriginatingServer | Gets the name of the server that is acting as the master server in a multiserver job. |
![]() |
OwnerLoginName | Gets or sets the owner of the job. |
![]() |
PageLevel | Gets or sets the completion action that determines whether to send a pager notification to an operator when the job finishes execution. |
![]() |
Parent | Gets or sets the JobServer object that is the parent of the Job object. |
![]() |
Properties | Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.) |
![]() |
ScalarResult | Gets the scalar result for the referenced object. (Inherited from SqlSmoObject.) |
![]() |
StartStepID | Gets or sets the ID value of the first job step in the sequence to be executed. |
![]() |
State | Gets the state of the referenced object. (Inherited from SmoObjectBase.) |
![]() |
Urn | Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.) |
![]() |
UserData | Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.) |
![]() |
VersionNumber | Gets a system-maintained value that is incremented every time the job is modified. |
Top
Events
Name | Description | |
---|---|---|
![]() |
PropertyChanged | (Inherited from SqlSmoObject.) |
![]() |
PropertyMetadataChanged | (Inherited from SqlSmoObject.) |
Top
Explicit Interface Implementations
Name | Description | |
---|---|---|
![]() ![]() |
IAlienObjectDiscover() | (Inherited from SqlSmoObject.) |
![]() ![]() |
IAlienObjectGetParent() | (Inherited from SqlSmoObject.) |
![]() ![]() |
IAlienObjectGetProperty(String) | (Inherited from SqlSmoObject.) |
![]() ![]() |
ISfcPropertyProviderGetPropertySet() | (Inherited from SqlSmoObject.) |
![]() ![]() |
IAlienObjectGetUrn() | (Inherited from SqlSmoObject.) |
![]() ![]() |
IAlienObjectResolve(String) | (Inherited from SqlSmoObject.) |
![]() ![]() |
IAlienObjectSetProperty(Object, Object) | (Inherited from SqlSmoObject.) |
Top