Alert Members

Include Protected Members
Include Inherited Members

The Alert class represents a Microsoft SQL Server Agent alert.

The Alert type exposes the following members.

Constructors

  Name Description
Public method Alert() Initializes a new instance of the Alert class.
Public method Alert(JobServer, String) Initializes a new instance of the Alert class on the specified instance of SQL Server Agent and with the specified name

Top

Methods

  Name Description
Protected method AddDatabaseContext(StringCollection) (Inherited from SqlSmoObject.)
Public method AddNotification(String, NotifyMethods) Designates an operator that receives a notification message when the alert is raised.
Public method Alter() Updates any Alert object property changes on 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.)
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 an alert on the instance of Microsoft SQL Server as defined by the Alert 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 Discover() (Inherited from SqlSmoObject.)
Public method Drop() Removes the alert.
Protected method DropImpl() (Inherited from SqlSmoObject.)
Protected method DropImplWorker(Urn%) (Inherited from SqlSmoObject.)
Public method EnumNotifications() Enumerates a list of all notifications defined on the alert.
Public method EnumNotifications(String) Enumerates a list of notification methods defined on the alert that are restricted to the specified operator.
Public method EnumNotifications(NotifyMethods)
Public method EnumNotifications(NotifyMethods, String)
Protected method EnumScriptImpl(ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method EnumScriptImplWorker(ScriptingOptions) (Inherited from SqlSmoObject.)
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.)
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 Refresh() Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public method RemoveNotification(String) Removes the notification of an operator from the alert definition.
Public method Rename(String) Renames the alert.
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 ResetOccurrenceCount() Resets the alert occurrence count back to zero.
Public method Script() Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent alert.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent alert 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 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 UpdateNotification(String, NotifyMethods) Changes the notification method associated with an operator for the alert.
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 AlertType Gets the AlertType object value that specifies the type of alert.
Public property CategoryName Gets or sets the name of the category to which the alert belongs.
Public property CountResetDate Gets or sets the date on which to reset the alert occurrence count back to zero.
Public property DatabaseName Gets or sets the name of the database that the alert is monitoring.
Public property DelayBetweenResponses Gets or sets the delay between responses in seconds.
Public property EventDescriptionKeyword Gets or sets a word or phrase that must appear in the text of an event message that causes the alert to be raised.
Public property EventSource Gets the event source text from the application event log.
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 HasNotification Gets the number of SQL Server Agent operators that are assigned to receive notification when the alert is fired.
Public property ID Gets the ID value that uniquely identifies SQL Server Agent.
Public property IncludeEventDescription Gets or sets the NotifyMethods object value that specifies the types of notification methods (e-mail, pager, or net send) that can contain alert error text.
Public property IsEnabled Gets or sets the Boolean property value that specifies whether the alert is enabled or not.
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 ID value of the SQL Server Agent job that is run in response to the alert being raised.
Public property JobName Gets or sets the name of the SQL Server Agent job that is run in response to the alert being raised.
Public property LastOccurrenceDate Gets or sets the date on which the alert was last raised.
Public property LastResponseDate Gets or sets the date on which the alert last generated a response.
Public property MessageID Gets or sets the ID value of the Microsoft SQL Server message that causes the alert to be raised.
Public property Name Gets or sets the name of the object. (Inherited from NamedSmoObject.)
Public property NotificationMessage Gets or sets the user-supplied text appended to any notification sent in response to an alert being raised.
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 OccurrenceCount Gets the number of times the alert has fired since the alert was enabled or since a specified date.
Public property Parent Gets or sets the JobServer object that is the parent of the Alert object.
Public property PerformanceCondition Gets or sets the performance condition text.
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 Severity Gets or sets the error message severity level that causes the alert to be raised.
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 WmiEventNamespace Gets or sets the Windows Management Instrumentation (WMI) namespace for the event.
Public property WmiEventQuery Gets or sets the Windows Management Instrumentation (WMI) query for the event.

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