CollectorConfigStore Class

Definition

public sealed class CollectorConfigStore : Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance, Microsoft.SqlServer.Management.Common.IAlterable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcAlterable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcDomain
type CollectorConfigStore = class
    inherit SfcInstance
    interface ISfcAlterable
    interface IAlterable
    interface ISfcDomain
    interface ISfcDomainLite
    interface ISfcHasConnection
Public NotInheritable Class CollectorConfigStore
Inherits SfcInstance
Implements IAlterable, ISfcAlterable, ISfcDomain
Inheritance
CollectorConfigStore
Implements

Constructors

CollectorConfigStore()

Creates a new instance of the config store

CollectorConfigStore(SqlStoreConnection)

Creates a new instance of the config store given a connection to the server hosting the collector

Properties

AbstractIdentityKey (Inherited from SfcInstance)
CacheDirectory

The temporary directory where the data between the collection and upload packages of each collector type is stored. If this value is Null, it will default at execution time to the value stored in the %TEMP% environment variable.

CacheWindow

This is the retention window of the locally collected data in the staging area between the collection and upload packages.

CollectionSets

Returns a collection of all the collection sets currently defined in the config store

Enabled

True if the Collector is enabled

IdentityKey
KeyChain

Returns the identity path of the object

(Inherited from SfcInstance)
MDWDatabase

The name of the database hosting the Management Data Warehouse

MDWInstance

The name of the instance hosting the Management Data Warehouse

Metadata (Inherited from SfcInstance)
Parent

Parent is not something that is kept local, it is implied from the keychain The concept of a parent is really about the hiearchy up and under the root if we only do this via parents then we will not be able to instantiate objects with only lightweight SfcKeyChain sets

Setting the parent is therefor a helper operation to set a keychain

(Inherited from SfcInstance)
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)
Urn

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

(Inherited from SfcInstance)

Methods

Alter()

Update the config store parameters on the server

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)
ConfigureTransactionPerformanceCollectors(SqlConnection)

Method creates transaction performance collection sets in case they don't exist

CreateIdentityKey() (Inherited from SfcInstance)
CreateImpl() (Inherited from SfcInstance)
DisableCollector()

Disable the collector

Discover(ISfcDependencyDiscoveryObjectSink) (Inherited from SfcInstance)
DropImpl() (Inherited from SfcInstance)
EnableCollector()

Enable the collector

EnumTypes()

Return a collection of all the defined collector types on th server

GetChildCollection(String)

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

(Inherited from SfcInstance)
GetDomain() (Inherited from SfcInstance)
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)
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)
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()
ISfcDomain.GetExecutionEngine()
ISfcDomain.GetKey(IUrnFragment)
ISfcDomain.GetType(String)
ISfcDomain.GetTypeMetadata(String)
ISfcDomain.UseSfcStateManagement()
ISfcDomainLite.DomainInstanceName

The logical name of a domain instance usually derived from the connection and domain information. This name does not have to be unique on the client, but should be different whenever the server representation would be.

ISfcDomainLite.DomainName

The name of the domain used to distinguish it from other domains. This is usually the end of the namespace qualifier.

ISfcDomainLite.GetLogicalVersion()

Returns the logical version of the domain

ISfcHasConnection.ConnectionContext
ISfcHasConnection.GetConnection()

Get the current connection to query on. Return a connection supporting a single serial query, so the query must end before another one may begin.

ISfcHasConnection.GetConnection(SfcObjectQueryMode)

Get the current connection to query on. Return a connection supporting either a single serial query or multiple simultaneously open queries as requested.

ISfcHasConnection.SetConnection(ISfcConnection)

Sets the active connection.

Applies to