CollectionSet Class

The CollectionSet class is derived from SFC::SfcInstanceBase and implements SFC::ICreatable, SFC::IDropable, and SFC::IAlterable.

System.Object
  Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance
    Microsoft.SqlServer.Management.Collector.CollectionSet

Namespace:  Microsoft.SqlServer.Management.Collector
Assembly:  Microsoft.SqlServer.Management.Collector (in Microsoft.SqlServer.Management.Collector.dll)

public sealed class CollectionSet : SfcInstance, 
	ISfcCreatable, ICreatable, ISfcDroppable, IDroppable, ISfcAlterable, 
	IAlterable, ISfcRenamable, ISfcDiscoverObject

The CollectionSet type exposes the following members.

  NameDescription
Public methodCollectionSet()Instantiates a collection set object.
Public methodCollectionSet(CollectorConfigStore, String)Initialize an instance of a CollectionSet given a CollectorConfigStore object as a parent and a collection set name.
Top

  NameDescription
Protected propertyAbstractIdentityKey (Inherited from SfcInstance.)
Public propertyCollectionItemsGets the collection items in a collection set.
Public propertyCollectionModeGets or sets the collection mode for the collection set.
Public propertyDaysUntilExpirationGets or sets the number of days that the collected data is saved in the management data warehouse.
Public propertyDescriptionGets or sets the description of the collection set.
Public propertyIdGets the local ID for the collection set.
Public propertyIdentityKeyGets the identity key for the collection set.
Public propertyIsRunningGets the Boolean property value that indicates whether or not the collection set is running.
Public propertyIsSystemGets the Boolean property value that indicates whether or the collection set is a system collection set.
Public propertyLoggingLevelGets or sets the logging level for the collection set.
Public propertyMetadata (Inherited from SfcInstance.)
Public propertyNameGets or sets the name of the collection set.
Public propertyParentGets or sets the parent store that this collection set belongs to.
Public propertyProperties (Inherited from SfcInstance.)
Protected propertyPropertyStorageProvider (Inherited from SfcInstance.)
Public propertyProxyNameGets or sets the name of the SQL Server Agent proxy account under which the collection set executes.
Public propertyScheduleNameGets or sets the name of the SQL Server Agent schedule that is associated to the collection set.
Public propertyStateGets the state of the collection set.
Public propertyTargetNameGets or sets the name of the target that the collection set will collect data from.
Public propertyUIdGets or sets the globally unique ID for the collection set.
Public propertyUrn (Inherited from SfcInstance.)
Top

  NameDescription
Public methodAlterAlter collection set information in the configuration store.
Protected methodAlterImpl (Inherited from SfcInstance.)
Protected methodCheckObjectCreated (Inherited from SfcInstance.)
Protected methodCheckObjectState (Inherited from SfcInstance.)
Public methodCreateCreates a collection set.
Protected methodCreateIdentityKey (Inherited from SfcInstance.)
Protected methodCreateImpl (Inherited from SfcInstance.)
Public methodDiscover (Inherited from SfcInstance.)
Public methodDropDrops a collection set.
Protected methodDropImpl (Inherited from SfcInstance.)
Public methodEnumCollectionSetExecutionHistory()An enumerator that gets the history records for specific collection set.
Public methodEnumCollectionSetExecutionHistory(Int64)This method is for internal use only.
Public methodEnumCollectionSetExecutionHistoryDetailThis method is for internal use only.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Protected methodGetChildCollection (Inherited from SfcInstance.)
Public methodGetDomain (Inherited from SfcInstance.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetLastUploadTimeGets the last time that collection set data was uploaded.
Public methodStatic memberGetObjectFactoryGets the object factory constructor for the [CollectorConfigStore] object.
Public methodGetPropertySet (Inherited from SfcInstance.)
Public methodGetType (Inherited from Object.)
Protected methodGetTypeMetadataImpl (Inherited from SfcInstance.)
Protected methodInitializeUIPropertyState (Inherited from SfcInstance.)
Protected methodMarkForDropImpl (Inherited from SfcInstance.)
Protected methodMarkRootAsConnected (Inherited from SfcInstance.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodMoveImpl (Inherited from SfcInstance.)
Protected methodOnPropertyMetadataChanges (Inherited from SfcInstance.)
Protected methodOnPropertyValueChanges (Inherited from SfcInstance.)
Protected methodPostAlter (Inherited from SfcInstance.)
Protected methodPostCreate (Inherited from SfcInstance.)
Protected methodPostDrop (Inherited from SfcInstance.)
Protected methodPostMove (Inherited from SfcInstance.)
Protected methodPostRename (Inherited from SfcInstance.)
Public methodRefresh (Inherited from SfcInstance.)
Public methodRenameRenames a collection set.
Protected methodRenameImpl (Inherited from SfcInstance.)
Protected methodResetKey (Inherited from SfcInstance.)
Public methodRunOnceSpecifies the collection set is to be run once.
Public methodScriptAlterThis method is for internal use only.
Public methodSerialize (Inherited from SfcInstance.)
Public methodStartStarts a collection set.
Public methodStopStops a collection set.
Public methodToString (Inherited from SfcInstance.)
Protected methodUpdateUIPropertyState (Inherited from SfcInstance.)
Public methodUploadUploads a collection set on demand.
Protected methodValidate (Inherited from SfcInstance.)
Top

  NameDescription
Protected eventpropertyChanged (Inherited from SfcInstance.)
Public eventPropertyChanged (Inherited from SfcInstance.)
Protected eventpropertyMetadataChanged (Inherited from SfcInstance.)
Public eventPropertyMetadataChanged (Inherited from SfcInstance.)
Top

  NameDescription
Explicit interface implemetationPrivate methodISfcDiscoverObject.DiscoverAllows the object to indicate relationships for dependency discovery requests via the passed sink. Do not reference this member directly in your code. It supports the SQL Server infrastructure.
Explicit interface implemetationPrivate methodISfcRenamable.RenameRenames this object to the specified key and updates the storage. Do not reference this member directly in your code. It supports the SQL Server infrastructure.
Explicit interface implemetationPrivate methodISfcCreatable.ScriptCreateProduces the script to create this object to storage in its current state. Do not reference this member directly in your code. It supports the SQL Server infrastructure.
Explicit interface implemetationPrivate methodISfcDroppable.ScriptDropProduces the script to drop this object from storage. Do not reference this member directly in your code. It supports the SQL Server infrastructure.
Explicit interface implemetationPrivate methodISfcRenamable.ScriptRenameProduces the script to rename this object to the specified key. Do not reference this member directly in your code. It supports the SQL Server infrastructure.
Top

This class is used for collection sets.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show: