Article
05/23/2011

CollectionSet Class

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

Inheritance Hierarchy

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)

Syntax

'Declaration
Public NotInheritable Class CollectionSet _
    Inherits SfcInstance _
    Implements ISfcCreatable, ICreatable, ISfcDroppable, IDroppable,  _
    ISfcAlterable, IAlterable, ISfcRenamable, ISfcDiscoverObject
'Usage
Dim instance As CollectionSet

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

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

[<SealedAttribute>]
type CollectionSet =  
    class
        inherit SfcInstance
        interface ISfcCreatable
        interface ICreatable
        interface ISfcDroppable
        interface IDroppable
        interface ISfcAlterable
        interface IAlterable
        interface ISfcRenamable
        interface ISfcDiscoverObject
    end

public final class CollectionSet extends SfcInstance implements ISfcCreatable, ICreatable, ISfcDroppable, IDroppable, ISfcAlterable, IAlterable, ISfcRenamable, ISfcDiscoverObject

The CollectionSet type exposes the following members.

Constructors

	Name	Description
	CollectionSet()	Instantiates a collection set object.
	CollectionSet(CollectorConfigStore, String)	Initialize an instance of a CollectionSet given a CollectorConfigStore object as a parent and a collection set name.

Top

Properties

	Name	Description
	AbstractIdentityKey	(Inherited from SfcInstance.)
	CollectionItems	Gets the collection items in a collection set.
	CollectionMode	Gets or sets the collection mode for the collection set.
	DaysUntilExpiration	Gets or sets the number of days that the collected data is saved in the management data warehouse.
	Description	Gets or sets the description of the collection set.
	Id	Gets the local ID for the collection set.
	IdentityKey	Gets the identity key for the collection set.
	IsRunning	Gets the Boolean property value that indicates whether or not the collection set is running.
	IsSystem	Gets the Boolean property value that indicates whether or the collection set is a system collection set.
	LoggingLevel	Gets or sets the logging level for the collection set.
	Metadata	(Inherited from SfcInstance.)
	Name	Gets or sets the name of the collection set.
	Parent	Gets or sets the parent store that this collection set belongs to.
	Properties	(Inherited from SfcInstance.)
	PropertyStorageProvider	(Inherited from SfcInstance.)
	ProxyName	Gets or sets the name of the SQL Server Agent proxy account under which the collection set executes.
	ScheduleName	Gets or sets the name of the SQL Server Agent schedule that is associated to the collection set.
	State	Gets the state of the collection set.
	TargetName	Gets or sets the name of the target that the collection set will collect data from.
	UId	Gets or sets the globally unique ID for the collection set.
	Urn	(Inherited from SfcInstance.)

Top

Methods

	Name	Description
	Alter	Alter collection set information in the configuration store.
	AlterImpl	(Inherited from SfcInstance.)
	CheckObjectCreated	(Inherited from SfcInstance.)
	CheckObjectState	(Inherited from SfcInstance.)
	Create	Creates a collection set.
	CreateIdentityKey	(Inherited from SfcInstance.)
	CreateImpl	(Inherited from SfcInstance.)
	Discover	(Inherited from SfcInstance.)
	Drop	Drops a collection set.
	DropImpl	(Inherited from SfcInstance.)
	EnumCollectionSetExecutionHistory()	An enumerator that gets the history records for specific collection set.
	EnumCollectionSetExecutionHistory(Int64)	This method is for internal use only.
	EnumCollectionSetExecutionHistoryDetail	This method is for internal use only.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetChildCollection	(Inherited from SfcInstance.)
	GetDomain	(Inherited from SfcInstance.)
	GetHashCode	(Inherited from Object.)
	GetLastUploadTime	Gets the last time that collection set data was uploaded.
	GetObjectFactory	Gets the object factory constructor for the [CollectorConfigStore] object.
	GetPropertySet	(Inherited from SfcInstance.)
	GetType	(Inherited from Object.)
	GetTypeMetadataImpl	(Inherited from SfcInstance.)
	InitializeUIPropertyState	(Inherited from SfcInstance.)
	MarkForDropImpl	(Inherited from SfcInstance.)
	MarkRootAsConnected	(Inherited from SfcInstance.)
	MemberwiseClone	(Inherited from Object.)
	MoveImpl	(Inherited from SfcInstance.)
	OnPropertyMetadataChanges	(Inherited from SfcInstance.)
	OnPropertyValueChanges	(Inherited from SfcInstance.)
	PostAlter	(Inherited from SfcInstance.)
	PostCreate	(Inherited from SfcInstance.)
	PostDrop	(Inherited from SfcInstance.)
	PostMove	(Inherited from SfcInstance.)
	PostRename	(Inherited from SfcInstance.)
	Refresh	(Inherited from SfcInstance.)
	Rename	Renames a collection set.
	RenameImpl	(Inherited from SfcInstance.)
	ResetKey	(Inherited from SfcInstance.)
	RunOnce	Specifies the collection set is to be run once.
	ScriptAlter	This method is for internal use only.
	Serialize	(Inherited from SfcInstance.)
	Start	Starts a collection set.
	Stop	Stops a collection set.
	ToString	(Inherited from SfcInstance.)
	UpdateUIPropertyState	(Inherited from SfcInstance.)
	Upload	Uploads a collection set on demand.
	Validate	(Inherited from SfcInstance.)

Top

Events

	Name	Description
	propertyChanged	(Inherited from SfcInstance.)
	PropertyChanged	(Inherited from SfcInstance.)
	propertyMetadataChanged	(Inherited from SfcInstance.)
	PropertyMetadataChanged	(Inherited from SfcInstance.)

Top

Explicit Interface Implementations

	Name	Description
	ISfcDiscoverObject.Discover	Allows 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.
	ISfcRenamable.Rename	Renames 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.
	ISfcCreatable.ScriptCreate	Produces 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.
	ISfcDroppable.ScriptDrop	Produces the script to drop this object from storage. Do not reference this member directly in your code. It supports the SQL Server infrastructure.
	ISfcRenamable.ScriptRename	Produces 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

Remarks

This class is used for collection sets.

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

Thread Safety

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

Share via