CollectionItem Class

  • Reference

Definition

Namespace:
Microsoft.SqlServer.Management.Collector
Assembly:
Microsoft.SqlServer.Management.Collector.dll
Package:
Microsoft.SqlServer.SqlManagementObjects v160.2004021.0
public sealed class CollectionItem : Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance, Microsoft.SqlServer.Management.Common.IAlterable, Microsoft.SqlServer.Management.Common.IMarkForDrop, Microsoft.SqlServer.Management.Common.IRenamable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcAlterable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcRenamable
type CollectionItem = class
    inherit SfcInstance
    interface ISfcAlterable
    interface IAlterable
    interface ISfcRenamable
    interface IRenamable
    interface IMarkForDrop
Public NotInheritable Class CollectionItem
Inherits SfcInstance
Implements IAlterable, IMarkForDrop, IRenamable, ISfcAlterable, ISfcRenamable
Inheritance
Object
SfcInstance
CollectionItem
Implements
IAlterable IMarkForDrop IRenamable ISfcAlterable ISfcRenamable

Constructors

CollectionItem(CollectionSet, String)

Create an instance of a collection item given the collection set and an item name

Properties

AbstractIdentityKey (Inherited from SfcInstance)
CollectionFrequency

The collection frequency for this item if the set is running in CollectionMode "continuous"
Id

Collection item id
IdentityKey

Key property
KeyChain

Returns the identity path of the object

(Inherited from SfcInstance)
Metadata (Inherited from SfcInstance)
Name

Collection item name
Parameters

An xml fragment representing the specific parameters for this collection item. It has to conform to the schema of the collector type that this item implements
Parent

Parent object in the om hierarchy; CollectionSet
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)
State (Inherited from SfcInstance)
TypeName

The collector type name that this collection item implements
Urn

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

(Inherited from SfcInstance)

Methods

Alter()

Alter a Collection Item by applying the changes to the configuration store
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)

Unused for now. Discovery for this should have been taken care of by the parent.
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()
GetPropertySet() (Inherited from SfcInstance)
GetTypeMetadataImpl() (Inherited from SfcInstance)
InitializeUIPropertyState()

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

(Inherited from SfcInstance)
MarkForDrop(Boolean)
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)
Rename(String)
RenameImpl(SfcKey) (Inherited from SfcInstance)
ResetKey() (Inherited from SfcInstance)
Serialize(XmlWriter) (Inherited from SfcInstance)
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

ISfcAlterable.ScriptAlter()
ISfcRenamable.Rename(SfcKey)
ISfcRenamable.ScriptRename(SfcKey)

Applies to