CollectionSet Class

Reference

Definition

Namespace:: Microsoft.SqlServer.Management.Collector

Assembly:: Microsoft.SqlServer.Management.Collector.dll

Package:: Microsoft.SqlServer.SqlManagementObjects v160.2004021.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

public sealed class CollectionSet : Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance, Microsoft.SqlServer.Management.Common.IAlterable, Microsoft.SqlServer.Management.Common.ICreatable, Microsoft.SqlServer.Management.Common.IDroppable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcAlterable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcCreatable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcDroppable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcRenamable

type CollectionSet = class
    inherit SfcInstance
    interface ISfcCreatable
    interface ICreatable
    interface ISfcDroppable
    interface IDroppable
    interface ISfcAlterable
    interface IAlterable
    interface ISfcRenamable
    interface ISfcDiscoverObject

Public NotInheritable Class CollectionSet
Inherits SfcInstance
Implements IAlterable, ICreatable, IDroppable, ISfcAlterable, ISfcCreatable, ISfcDroppable, ISfcRenamable

Inheritance: Object

SfcInstance
CollectionSet

Implements: IAlterable ICreatable IDroppable ISfcAlterable ISfcCreatable ISfcDiscoverObject ISfcDroppable ISfcRenamable

Constructors

CollectionSet()

Default constructor used for deserialization and for the factory

CollectionSet must have a public parameterless constructor in order to use it as parameter 'TDcInstance' in the generic type or method 'Microsoft.SqlServer.Management.DataCollectionUITasks.DcTaskFormComponent TDcInstance

CollectionSet(CollectorConfigStore, String)

Initialize an instance of a CollectionSet given a CollectorConfigStore object as a parent and a name

Properties

AbstractIdentityKey	(Inherited from SfcInstance)
CollectionItems	The collection items belonging to this collection set
CollectionMode	Collection mode for the collection set. CollectionSet.CollectionModes
DaysUntilExpiration	Defines how long the collected data should be kept in the repository
Description	Free text description of the collection set
Id	Id of the collection set in the config store
IdentityKey	Key property
IsRunning	True if the collection set is currently executing
IsSystem	True if the set is a system collection set
IsTransactionPerformance	True if the set is one of defined Transaction Performance collection sets
KeyChain	Returns the identity path of the object (Inherited from SfcInstance)
LoggingLevel	Logging level for the collection set.
Metadata	(Inherited from SfcInstance)
Name	Collection set name
Parent	Parent object in the object model hierarchy; CollectorConfigStore
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)
ProxyName	Name of the SQL Agent proxy account the collection set uses to connect to target and the Management Data Warehouse
ScheduleName	Name of the SQL Agent schedule for the collection set. Used to drive the collection set upload in "Cached" colleciton mode, and to drive the snampshot collection in "Snapshot" collection mode
State	Object state of collection set
TargetName	Name of the target from which the collection set is collecting data
UId	A GUID uniqely identifying the collection set
Urn	Create a new Urn string on each request and return it. (Inherited from SfcInstance)

Methods

Alter()	Alter the collection set on the config store. Only the schedule, the target, the proxy, and the description could be updated. Items can also be added dropped or altered
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)
Cleanup()	This method cleans up all activities done while configuring/starting/running this collection set Cleanup tasks: Delete collect, upload jobs Change set's state to out of the box settings Set Data collector to non-configured state if this collection set is the last running set Delete all collection set logs
Create()	Create a collection set on the config store
CreateIdentityKey()	(Inherited from SfcInstance)
CreateImpl()	(Inherited from SfcInstance)
Discover(ISfcDependencyDiscoveryObjectSink)	(Inherited from SfcInstance)
Drop()	Drop the collectoin set from the config store
DropImpl()	(Inherited from SfcInstance)
EnumCollectionSetExecutionHistory()	Gets the top-level history records for given collection set
EnumCollectionSetExecutionHistory(Int64)	Gets history records for given collection set for a given parent log id
EnumCollectionSetExecutionHistoryDetail(Int64)	Gets detail records for given collection set execution (logId)
GetChildCollection(String)	Get the child collection in this instance for the given element name string. (Inherited from SfcInstance)
GetDomain()	(Inherited from SfcInstance)
GetLastUploadTime()	Gets the time last successful upload finished
GetObjectFactory()	Returns an object factory for the CollectionSet class
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)
Rename(String)
RenameImpl(SfcKey)	(Inherited from SfcInstance)
ResetKey()	(Inherited from SfcInstance)
RunOnce()	Run a collection and upload once, on demand. A single snapshot of data will be collected and uploaded to the Management Data Warehouse. Can only be used if the collection mode is "NonCached".
ScriptAlter()	Script alter for collection set objects
Serialize(XmlWriter)	(Inherited from SfcInstance)
Start()	Start collection from a collection set
Stop()	Stop collection from a running collection set
ToString()	(Inherited from SfcInstance)
UpdateUIPropertyState()	(Inherited from SfcInstance)
Upload()	Do an on demand upload on the collection set to the Management Data Warehouse. Only meaningful if the collection mode is "Cached" and the set is currently running.
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

ISfcCreatable.ScriptCreate()
ISfcDiscoverObject.Discover(ISfcDependencyDiscoveryObjectSink)
ISfcDroppable.ScriptDrop()
ISfcRenamable.Rename(SfcKey)
ISfcRenamable.ScriptRename(SfcKey)

Applies to

Partilhar via