Job 类

The Job class represents a Microsoft SQL Server Agent job.

命名空间:  Microsoft.SqlServer.Management.Smo.Agent
程序集:  Microsoft.SqlServer.Smo(在 Microsoft.SqlServer.Smo.dll 中)

语法

声明
Public NotInheritable Class Job _
    Inherits AgentObjectBase _
    Implements IAlterable, ICreatable, IDroppable, IRenamable,  _
    IScriptable
用法
Dim instance As Job
public sealed class Job : AgentObjectBase, IAlterable, 
    ICreatable, IDroppable, IRenamable, IScriptable
public ref class Job sealed : public AgentObjectBase, 
    IAlterable, ICreatable, IDroppable, IRenamable, IScriptable
[<SealedAttribute>]
type Job =  
    class
        inherit AgentObjectBase
        interface IAlterable
        interface ICreatable
        interface IDroppable
        interface IRenamable
        interface IScriptable
    end
public final class Job extends AgentObjectBase implements IAlterable, ICreatable, IDroppable, IRenamable, IScriptable

Job 类型公开以下成员。

构造函数

  名称 说明
公共方法 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

页首

属性

  名称 说明
公共属性 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. (从 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. (从 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 (覆盖 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. (从 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. (从 SqlSmoObject 继承。)
受保护属性 ScalarResult Gets the scalar result for the referenced object. (从 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. (从 SmoObjectBase 继承。)
公共属性 Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (从 SqlSmoObject 继承。)
公共属性 UserData Gets or sets user-defined data associated with the referenced object. (从 SmoObjectBase 继承。)
公共属性 VersionNumber Gets a system-maintained value that is incremented every time the job is modified.

页首

方法

  名称 说明
受保护方法 AddDatabaseContext (从 SqlSmoObject 继承。)
公共方法 AddSharedSchedule 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 (从 SqlSmoObject 继承。)
受保护方法 AlterImplFinish (从 SqlSmoObject 继承。)
受保护方法 AlterImplInit (从 SqlSmoObject 继承。)
受保护方法 AlterImplWorker (从 SqlSmoObject 继承。)
公共方法 ApplyToTargetServer Adds a server to the list of target servers maintained for the referenced Microsoft SQL Server Agent job.
公共方法 ApplyToTargetServerGroup Adds one or more servers to the list of target servers maintained for the referenced Microsoft SQL Server Agent job.
受保护方法 BindDefaultImpl (从 SqlSmoObject 继承。)
受保护方法 BindRuleImpl (从 SqlSmoObject 继承。)
受保护方法 CheckCollation (从 SqlSmoObject 继承。)
受保护方法 CheckObjectState() () () () Validates the state of the referenced object. (从 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. (从 SqlSmoObject 继承。)
受保护方法 CheckObjectStateImpl (从 SqlSmoObject 继承。)
受保护方法 CheckVersion100 (从 SqlSmoObject 继承。)
受保护方法 CheckVersion80 Checks the validity of the object on SQL Server 2000. (从 SqlSmoObject 继承。)
受保护方法 CheckVersion80SP3 Checks the validity of the object on SQL Server 2000 SP3. (从 SqlSmoObject 继承。)
受保护方法 CheckVersion90 Check the validity of the object on SQL Server 2005. (从 SqlSmoObject 继承。)
受保护方法 CheckVersionBelow90 (从 SqlSmoObject 继承。)
受保护方法 CleanObject (从 SqlSmoObject 继承。)
公共方法 Create Creates a job on the instance of Microsoft SQL Server as defined by the Job object.
受保护方法 CreateImpl (从 SqlSmoObject 继承。)
受保护方法 CreateImplFinish (从 SqlSmoObject 继承。)
受保护方法 CreateImplInit (从 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 (从 SqlSmoObject 继承。)
公共方法 Drop() () () () Removes an existing job.
公共方法 Drop(Boolean) Removes an existing job.
受保护方法 DropImpl (从 SqlSmoObject 继承。)
受保护方法 DropImplWorker (从 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 (从 SqlSmoObject 继承。)
受保护方法 EnumScriptImplWorker (从 SqlSmoObject 继承。)
公共方法 EnumTargetServers Enumerates a list of execution target servers that have been assigned to the referenced job.
公共方法 Equals (从 Object 继承。)
受保护方法 Finalize (从 Object 继承。)
受保护方法 FormatSqlVariant (从 SqlSmoObject 继承。)
受保护方法 GenerateDataSpaceFileStreamScript (从 SqlSmoObject 继承。)
受保护方法 GenerateDataSpaceScript (从 SqlSmoObject 继承。)
受保护方法 GetBindDefaultScript (从 SqlSmoObject 继承。)
受保护方法 GetBindRuleScript (从 SqlSmoObject 继承。)
受保护方法 GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) (从 SqlSmoObject 继承。)
受保护方法 GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) (从 SqlSmoObject 继承。)
受保护方法 GetDateTimeParameter (从 SqlSmoObject 继承。)
受保护方法 GetDateTimeParameterAsInt (从 SqlSmoObject 继承。)
受保护方法 GetDBName Gets the database name that is associated with the object. (从 AgentObjectBase 继承。)
受保护方法 GetEnumParameter (从 SqlSmoObject 继承。)
受保护方法 GetFragOptionString (从 SqlSmoObject 继承。)
受保护方法 GetGuidParameter (从 SqlSmoObject 继承。)
公共方法 GetHashCode (从 Object 继承。)
受保护方法 GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) (从 SqlSmoObject 继承。)
受保护方法 GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) (从 SqlSmoObject 继承。)
受保护方法 GetPropValue (从 SqlSmoObject 继承。)
受保护方法 GetPropValueOptional (从 SqlSmoObject 继承。)
受保护方法 GetPropValueOptionalAllowNull (从 SqlSmoObject 继承。)
受保护方法 GetRealValue (从 SqlSmoObject 继承。)
受保护方法 GetScriptingOptionsForCreate (从 SqlSmoObject 继承。)
受保护方法 GetServerName Gets the name of the instance of SQL Server with which the object is associated. (从 SqlSmoObject 继承。)
受保护方法 GetServerObject (从 SqlSmoObject 继承。)
受保护方法 GetSqlServerVersionName Gets the version name of the instance of SQL Server with which the object is associated. (从 SqlSmoObject 继承。)
受保护方法 GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) (从 SqlSmoObject 继承。)
受保护方法 GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) (从 SqlSmoObject 继承。)
受保护方法 GetTimeSpanParameterAsInt (从 SqlSmoObject 继承。)
公共方法 GetType (从 Object 继承。)
受保护方法 GetUrnRecursive(StringBuilder) (从 SqlSmoObject 继承。)
受保护方法 GetUrnRecursive(StringBuilder, UrnIdOption) (从 SqlSmoObject 继承。)
受保护方法 ImplInitialize (从 SqlSmoObject 继承。)
公共方法 Initialize() () () () Initializes the object and forces the properties be loaded. (从 SqlSmoObject 继承。)
公共方法 Initialize(Boolean) Initializes the object and forces the properties be loaded. (从 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. (从 SqlSmoObject 继承。)
受保护方法 IsObjectInitialized Verifies whether the object has been initialized. (从 SqlSmoObject 继承。)
受保护方法 IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (从 SqlSmoObject 继承。)
受保护方法 IsVersion80SP3 (从 SqlSmoObject 继承。)
受保护方法 MarkDropped (从 SqlSmoObject 继承。)
受保护方法 MarkForDropImpl (从 SqlSmoObject 继承。)
受保护方法 MemberwiseClone (从 Object 继承。)
受保护方法 PostAlter (从 SqlSmoObject 继承。)
受保护方法 PostCreate (从 SqlSmoObject 继承。)
受保护方法 PostDrop (从 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. (从 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 Removes an execution target server from the list of target servers maintained for a job.
公共方法 RemoveFromTargetServerGroup 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 Renames the job.
受保护方法 RenameImpl This method supports the SMO infrastructure and is not intended to be used directly from your code. (从 NamedSmoObject 继承。)
受保护方法 RenameImplWorker This method supports the SMO infrastructure and is not intended to be used directly from your code. (从 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 (从 SqlSmoObject 继承。)
受保护方法 ScriptChangeOwner This method supports the SMO infrastructure and is not intended to be used directly from your code. (从 NamedSmoObject 继承。)
受保护方法 ScriptCreate (从 SqlSmoObject 继承。)
受保护方法 ScriptDdl (从 SqlSmoObject 继承。)
受保护方法 ScriptDrop (从 SqlSmoObject 继承。)
受保护方法 ScriptImpl() () () () (从 SqlSmoObject 继承。)
受保护方法 ScriptImpl(ScriptingOptions) (从 SqlSmoObject 继承。)
受保护方法 ScriptImplWorker (从 SqlSmoObject 继承。)
受保护方法 ScriptRename This method supports the SMO infrastructure and is not intended to be used directly from your code. (从 NamedSmoObject 继承。)
受保护方法 SetParentImpl (从 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. (从 SqlSmoObject 继承。)
受保护方法 TouchImpl (从 SqlSmoObject 继承。)
受保护方法 UnbindDefaultImpl (从 SqlSmoObject 继承。)
受保护方法 UnbindRuleImpl (从 SqlSmoObject 继承。)
公共方法 Validate (从 SmoObjectBase 继承。)

页首

事件

  名称 说明
公共事件 PropertyChanged (从 SqlSmoObject 继承。)
公共事件 PropertyMetadataChanged (从 SqlSmoObject 继承。)

页首

字段

  名称 说明
受保护字段 m_ExtendedProperties (从 SqlSmoObject 继承。)

页首

显式接口实现

  名称 说明
显式接口实现私有方法 IAlienObjectDiscover (从 SqlSmoObject 继承。)
显式接口实现私有方法 IAlienObjectGetParent (从 SqlSmoObject 继承。)
显式接口实现私有方法 IAlienObjectGetProperty (从 SqlSmoObject 继承。)
显式接口实现私有方法 ISfcPropertyProviderGetPropertySet (从 SqlSmoObject 继承。)
显式接口实现私有方法 IAlienObjectGetUrn (从 SqlSmoObject 继承。)
显式接口实现私有方法 IAlienObjectResolve (从 SqlSmoObject 继承。)
显式接口实现私有方法 IAlienObjectSetProperty (从 SqlSmoObject 继承。)

页首

注释

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

此类型的任何公共静态(Microsoft Visual Basic 中的 Shared)成员在多线程操作中是安全的。 不保证所有实例成员都对于线程安全的。

线程安全

此类型的任何公共 static(在 Visual Basic 中为 Shared) 成员都是线程安全的。不保证所有实例成员都是线程安全的。