Share via


Target Class

Definition

Runtime class for Target. Each instance of this class represents a row in sys.server_event_session_targets.

public sealed class Target : Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance, Microsoft.SqlServer.Management.XEvent.ISessionObject
type Target = class
    inherit SfcInstance
    interface ISfcDiscoverObject
    interface ISessionObject
Public NotInheritable Class Target
Inherits SfcInstance
Implements ISessionObject
Inheritance
Implements

Constructors

Target()

Initializes a new instance of the Target class. Empty constructor is an convention is a convention in SFC.

Target(Session, String)

Initializes a new instance of the Target class with given parent and name.

Target(Session, TargetInfo)

Initializes a new instance of the Event class from an TargetInfo object.

Fields

TypeTypeName

Type name

Properties

AbstractIdentityKey (Inherited from SfcInstance)
Description

Gets or sets target description. Set accessor is for internal use only.

ID

Gets the description.

IdentityKey

Gets the identity key.

KeyChain

Returns the identity path of the object

(Inherited from SfcInstance)
Metadata (Inherited from SfcInstance)
ModuleID

Gets the module ID.

Name

The name of the Target

PackageName

Gets the package name that the event belongs to.

Parent

Parent Property for Event.

Properties (Inherited from SfcInstance)
PropertyStorageProvider

This property returns the default implementation of SFC for ISfcPropertyStorageProvider interface, it can be overriden in the child classes to return another storage provider (i.e. flat properties list)

(Inherited from SfcInstance)
ScriptName

Gets Name formatted for scripting.

State

State of the object, used in Alter function in session.

TargetFields

Gets the target column info set.

Urn

Create a new Urn string on each request and return it.

(Inherited from SfcInstance)

Methods

AlterImpl() (Inherited from SfcInstance)
CheckObjectCreated()

To be called from domain for when an API requires the object to be Created Stronger than CheckObjectState

(Inherited from SfcInstance)
CheckObjectState()

To be called from domain for any access to the object

(Inherited from SfcInstance)
CreateIdentityKey() (Inherited from SfcInstance)
CreateImpl() (Inherited from SfcInstance)
Discover(ISfcDependencyDiscoveryObjectSink) (Inherited from SfcInstance)
DropImpl() (Inherited from SfcInstance)
GetChildCollection(String)

Get the child collection in this instance for the given element name string.

(Inherited from SfcInstance)
GetDomain() (Inherited from SfcInstance)
GetObjectFactory()

Gets the object factory.

GetPropertySet() (Inherited from SfcInstance)
GetTargetData()

Gets the target data.

GetTypeMetadata()

Gets Sfc Type Metadata.

GetTypeMetadataImpl() (Inherited from SfcInstance)
HasCustomizableField()

Determines whether the target has at least one field needs to be set.

InitializeUIPropertyState()

Overridable from the child objects who care about initializing their states (dynamic metadata which is currently the ".Enabled" property)

(Inherited from SfcInstance)
MarkForDropImpl(Boolean) (Inherited from SfcInstance)
MarkRootAsConnected() (Inherited from SfcInstance)
MoveImpl(SfcInstance) (Inherited from SfcInstance)
OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs) (Inherited from SfcInstance)
OnPropertyValueChanges(PropertyChangedEventArgs) (Inherited from SfcInstance)
PostAlter(Object) (Inherited from SfcInstance)
PostCreate(Object) (Inherited from SfcInstance)
PostDrop(Object) (Inherited from SfcInstance)
PostMove(Object) (Inherited from SfcInstance)
PostRename(Object) (Inherited from SfcInstance)
Refresh()

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

(Inherited from SfcInstance)
RenameImpl(SfcKey) (Inherited from SfcInstance)
ResetKey() (Inherited from SfcInstance)
Serialize(XmlWriter) (Inherited from SfcInstance)
SetTargetInfo(TargetInfo)

Set the TargetInfo for a pending Target.

ToString() (Inherited from SfcInstance)
UpdateUIPropertyState() (Inherited from SfcInstance)
Validate()

Basic child object's validation

(Inherited from SfcInstance)

Events

propertyChanged (Inherited from SfcInstance)
PropertyChanged (Inherited from SfcInstance)
propertyMetadataChanged (Inherited from SfcInstance)
PropertyMetadataChanged (Inherited from SfcInstance)

Explicit Interface Implementations

ISessionObject.GetCreateScript()

Generate the script for add an target. Used in Create Session.

ISessionObject.GetDropScript()

Generating the script for drop the event. Used in Alter Session.

ISessionObject.IsDirty()
ISfcDiscoverObject.Discover(ISfcDependencyDiscoveryObjectSink)

Applies to